diff --git a/.github/workflows/os/releasemaker.os b/.github/workflows/os/releasemaker.os index 65d4f4ce8a..0df15eb2bd 100644 --- a/.github/workflows/os/releasemaker.os +++ b/.github/workflows/os/releasemaker.os @@ -9,7 +9,7 @@ Процедура НачалоРаботы() Репозиторий = "https://github.com/Bayselonarrend/OpenIntegrations"; - Версия = "1.10.0"; + Версия = "1.11.0"; Режим = "CONFIG"; //Локальные данные diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md new file mode 100644 index 0000000000..ee4ba57a0f --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 2 +--- + +# Create new subfolder + Create new folder inside another folder + + + +`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Parent folder identifier | + | Name | --title | String | Name of new folder | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) +::: +
+ + +```bsl title="Code example" + FolderID = "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/Catalogs-managment/Delete-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md new file mode 100644 index 0000000000..cb6efa151c --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 5 +--- + +# Delete folder + Remove folder with subfolders + + + +`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | ID of folder to be deleted | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + FolderID = "480"; + + Result = OPI_Bitrix24.DeleteFolder(URL, FolderID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + FolderID = "482"; + + Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1719047257.50616, + "finish": 1719047257.55445, + "duration": 0.048285961151123, + "processing": 0.0174880027770996, + "date_start": "2024-06-22T09:07:37+00:00", + "date_finish": "2024-06-22T09:07:37+00:00", + "operating_reset_at": 1719047857, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md new file mode 100644 index 0000000000..be15a42c4c --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 6 +--- + +# Get external link for folder + Get external link to folder + + + +`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/Catalogs-managment/Get-folder-filter-structure.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md new file mode 100644 index 0000000000..462cf4e238 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 11 +--- + +# Get fields structure for folder items filter + Returns filter structure for child folder items + + + +`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Structure of Key-Value - Fields structure + +
+ +:::tip +Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/Catalogs-managment/Get-folder-information.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md new file mode 100644 index 0000000000..ceed6c8085 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 1 +--- + +# Get information about folder + Get folder information + + + +`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/Catalogs-managment/Get-folder-items.md b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md new file mode 100644 index 0000000000..608b7fb00d --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md @@ -0,0 +1,101 @@ +--- +sidebar_position: 7 +--- + +# Get folder child elements + Get folder child elements + + + +`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Filter | --filter | Structure of 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 + +
+ +:::tip +Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/Catalogs-managment/Make-folder-copy.md b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md new file mode 100644 index 0000000000..c6edcb7f48 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 3 +--- + +# Copy folder + Copy one folder to another + + + +`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | DestinationID | --tagetid | String, Number | ID of target folder | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) +::: +
+ + +```bsl title="Code example" + DestinationID = "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/Catalogs-managment/Mark-folder-as-deleted.md b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md new file mode 100644 index 0000000000..7517b53866 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 8 +--- + +# Mark folder as deleted + Move folder to recycle bin + + + +`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/Catalogs-managment/Move-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md new file mode 100644 index 0000000000..caeefd91fb --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 4 +--- + +# Move folder + Moves one folder inside another + + + +`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | DestinationID | --tagetid | String, Number | ID of target folder | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) +::: +
+ + +```bsl title="Code example" + DestinationID = "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/Catalogs-managment/Rename-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md new file mode 100644 index 0000000000..357335aee7 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 10 +--- + +# Rename folder + Change folder name + + + +`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Name | --title | String | New folders name | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New catalog"; + Filename2 = "New folder 2"; + + FolderID2 = "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/Catalogs-managment/Restore-folder.md b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md new file mode 100644 index 0000000000..f053817038 --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 9 +--- + +# Restore folder + Resotre folder form recycle bin + + + +`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FolderID | --folderid | String, Number | Folder identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/Catalogs-managment/_category_.json b/docs/en/md/Bitrix24/Catalogs-managment/_category_.json new file mode 100644 index 0000000000..cf7eaa2f0d --- /dev/null +++ b/docs/en/md/Bitrix24/Catalogs-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Catalogs managment", +"position": "10" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md new file mode 100644 index 0000000000..9c6b7236e7 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 4 +--- + +# Add users to chat + Adds users to the chat by ID array + + + +`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserIDs | --users | Array of string, number | New members IDs | + | HideHistory | --hide | Boolean | Hide old messages from new members | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + UserIDs = New Array; + UserIDs.Add(10); + UserIDs.Add(12); + + Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + UserID = 10; + + Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddUsersToChat --url %url% --chat %chat% --users %users% --hide %hide% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865686.43672, + "finish": 1720865686.52541, + "duration": 0.0886859893798828, + "processing": 0.0491659641265869, + "date_start": "2024-07-13T10:14:46+00:00", + "date_finish": "2024-07-13T10:14:46+00:00", + "operating_reset_at": 1720866286, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md new file mode 100644 index 0000000000..db4648967e --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md @@ -0,0 +1,74 @@ +--- +sidebar_position: 7 +--- + +# Change chat color + Chat chat color for mobile app + + + +`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Color | --color | String | New chat color | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) + + Available colors: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, + + MARENGO, GRAY, GRAPHITE +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Color = "AZURE"; + + Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Color = "PURPLE"; + + Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatColor --url %url% --chat %chat% --color %color% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865688.95778, + "finish": 1720865689.02493, + "duration": 0.0671589374542236, + "processing": 0.0428512096405029, + "date_start": "2024-07-13T10:14:48+00:00", + "date_finish": "2024-07-13T10:14:49+00:00", + "operating_reset_at": 1720866288, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md new file mode 100644 index 0000000000..207b57a832 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 9 +--- + +# Change chat owner + Change chat owner + + + +`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserID | --user | String, Number | User ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + UserID = 10; + + Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatOwner --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865697.10595, + "finish": 1720865697.13924, + "duration": 0.0332820415496826, + "processing": 0.0104668140411377, + "date_start": "2024-07-13T10:14:57+00:00", + "date_finish": "2024-07-13T10:14:57+00:00", + "operating_reset_at": 1720866297, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md new file mode 100644 index 0000000000..49064ee8c4 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 8 +--- + +# Change chat picture + Setup new chat picture + + + +`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Image | --picture | String, BinaryData | Picture data | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Image = FunctionParameters["Picture2"]; + + Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatPicture --url %url% --chat %chat% --picture %picture% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865692.90718, + "finish": 1720865693.81896, + "duration": 0.91178297996521, + "processing": 0.884725093841553, + "date_start": "2024-07-13T10:14:52+00:00", + "date_finish": "2024-07-13T10:14:53+00:00", + "operating_reset_at": 1720866292, + "operating": 0.884703874588013 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md new file mode 100644 index 0000000000..7309a96872 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md @@ -0,0 +1,70 @@ +--- +sidebar_position: 6 +--- + +# Change chat title + Change text of chat title + + + +`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Title | --title | String | New title | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Title = "New chat title"; + + Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Title = "Another title"; + + Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ChangeChatTitle --url %url% --chat %chat% --title %title% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865687.70928, + "finish": 1720865687.78107, + "duration": 0.0717928409576416, + "processing": 0.0479631423950195, + "date_start": "2024-07-13T10:14:47+00:00", + "date_finish": "2024-07-13T10:14:47+00:00", + "operating_reset_at": 1720866287, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md new file mode 100644 index 0000000000..a259cfc318 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 1 +--- + +# Create chat + Creates a new chat based on the field structure + + + +`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatStructure | --fields | Structure of Key-Value | Chat fields structure. See GetChatStructure | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) +::: +
+ + +```bsl title="Code example" + Image = FunctionParameters["Picture"]; + OPI_TypeConversion.GetBinaryData(Image); + + B64Image = GetBase64StringFromBinaryData(Image); + + MembersArray = New Array; + MembersArray.Add(10); + MembersArray.Add(1); + + ChatStructure = New Structure; + ChatStructure.Insert("TYPE", "OPEN"); + ChatStructure.Insert("TITLE", "New chat"); + ChatStructure.Insert("DESCRIPTION", "This is a new chat"); + ChatStructure.Insert("COLOR", "GREEN"); + ChatStructure.Insert("MESSAGE", "Welcome to new chat"); + ChatStructure.Insert("USERS", MembersArray); + ChatStructure.Insert("AVATAR", B64Image); + ChatStructure.Insert("OWNER_ID", 1); + + URL = FunctionParameters["Bitrix24_URL"]; + + Result = OPI_Bitrix24.CreateChat(URL, ChatStructure); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + ChatStructure = New Structure; + ChatStructure.Insert("TYPE", "CHAT"); + ChatStructure.Insert("TITLE", "Private chat"); + ChatStructure.Insert("USERS", MembersArray); + + Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateChat --url %url% --fields %fields% --token %token% + +``` + +```json title="Result" +{ + "result": 26, + "time": { + "start": 1720816597.42171, + "finish": 1720816597.52933, + "duration": 0.107618093490601, + "processing": 0.081672191619873, + "date_start": "2024-07-12T20:36:37+00:00", + "date_finish": "2024-07-12T20:36:37+00:00", + "operating_reset_at": 1720817197, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md new file mode 100644 index 0000000000..f08e03c08e --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 5 +--- + +# Delete user from chat + Deletes user from chat + + + +`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | UserID | --user | String, Number | User ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + UserID = 10; + + Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteUserFromChat --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865685.25089, + "finish": 1720865685.32425, + "duration": 0.0733590126037598, + "processing": 0.0480890274047852, + "date_start": "2024-07-13T10:14:45+00:00", + "date_finish": "2024-07-13T10:14:45+00:00", + "operating_reset_at": 1720866285, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md new file mode 100644 index 0000000000..6af7a4c224 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 10 +--- + +# Disable chat notifications + Disable chat notifications + + + +`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DisableChatNotifications --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865694.86568, + "finish": 1720865694.9092, + "duration": 0.0435128211975098, + "processing": 0.0169928073883057, + "date_start": "2024-07-13T10:14:54+00:00", + "date_finish": "2024-07-13T10:14:54+00:00", + "operating_reset_at": 1720866294, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md new file mode 100644 index 0000000000..38d483ebd0 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 11 +--- + +# Enable chat notifications + Enable chat notifications + + + +`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 EnableChatNotifications --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720865695.99933, + "finish": 1720865696.04205, + "duration": 0.0427119731903076, + "processing": 0.0170090198516846, + "date_start": "2024-07-13T10:14:55+00:00", + "date_finish": "2024-07-13T10:14:56+00:00", + "operating_reset_at": 1720866296, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md new file mode 100644 index 0000000000..4c87b1cbd8 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 17 +--- + +# Get chat files folder + Get information about folder for chat files + + + +`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatFilesFolder --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": 3250 + }, + "time": { + "start": 1720969169.10256, + "finish": 1720969169.1584, + "duration": 0.0558350086212158, + "processing": 0.0327038764953613, + "date_start": "2024-07-14T14:59:29+00:00", + "date_finish": "2024-07-14T14:59:29+00:00", + "operating_reset_at": 1720969769, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md new file mode 100644 index 0000000000..f7fd74a110 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md @@ -0,0 +1,121 @@ +--- +sidebar_position: 14 +--- + +# Get chat members list + Get chat members list + + + +`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat" + FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + + Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatMembersList --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + }, + { + "id": 1, + "active": true, + "name": "Anton Titovets", + "first_name": "Anton", + "last_name": "Titovets", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + } + ], + "total": 2, + "time": { + "start": 1720969161.4388, + "finish": 1720969161.46946, + "duration": 0.0306570529937744, + "processing": 0.00571608543395996, + "date_start": "2024-07-14T14:59:21+00:00", + "date_finish": "2024-07-14T14:59:21+00:00", + "operating_reset_at": 1720969761, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md new file mode 100644 index 0000000000..d8072fb252 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md @@ -0,0 +1,401 @@ +--- +sidebar_position: 12 +--- + +# Get chat messages list + Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified + + + +`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | LastID | --last | String, Number | Id of last message | + | FirstID | --first | String, Number | ID of first message | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat4"; + + Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID); + + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + + Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0,Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatMessagesList --url %url% --chat %chat% --last %last% --first %first% --token %token% + +``` + +```json title="Result" +{ + "result": { + "chat_id": 10, + "messages": [ + { + "id": 3854, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T14:54:43+00:00", + "text": "Write it!", + "unread": false, + "uuid": "700d361d-8324-47fb-b989-647949c1c899", + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4286, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:06:51+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4366, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:40:58+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4406, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:57:33+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4446, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:21:27+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4486, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:22:30+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4526, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:41:21+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4668, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:10:33+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4708, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:22:56+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4748, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:26:01+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4788, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:01+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4828, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:36+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4868, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:30:18+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4908, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:52:24+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4948, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:53:31+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4990, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:57:06+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5060, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:59:43+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5140, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:29:40+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5182, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:35:56+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5262, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T11:27:54+00:00", + "text": "This message was deleted", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + } + ], + "users": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + }, + { + "id": 1, + "active": true, + "name": "Anton Titovets", + "first_name": "Anton", + "last_name": "Titovets", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + } + ], + "files": [] + }, + "time": { + "start": 1720969156.38474, + "finish": 1720969156.42064, + "duration": 0.0358970165252686, + "processing": 0.0108029842376709, + "date_start": "2024-07-14T14:59:16+00:00", + "date_finish": "2024-07-14T14:59:16+00:00", + "operating_reset_at": 1720969756, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md new file mode 100644 index 0000000000..9c1350a4c7 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 18 +--- + +# Get chats structure + Get chat fields structure + + + +`Function GetChatStructure(Val Clear = False) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Clear | --empty | Boolean | True > structure with empty values, False > field types at values | + + + Returns: Structure of Key-Value - Fields structure + +
+ + + + + + + +```sh title="CLI command example" + + oint bitrix24 GetChatStructure --empty %empty% + +``` + + diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md new file mode 100644 index 0000000000..3c4fc16290 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 2 +--- + +# Get chats users + Gets the list of chat users by ID + + + +`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.GetChatUsers(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetChatUsers --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": [ + 1, + 10 + ], + "time": { + "start": 1720816598.61771, + "finish": 1720816598.64882, + "duration": 0.0311079025268555, + "processing": 0.00316882133483887, + "date_start": "2024-07-12T20:36:38+00:00", + "date_finish": "2024-07-12T20:36:38+00:00", + "operating_reset_at": 1720817198, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md new file mode 100644 index 0000000000..405a1c2e4d --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md @@ -0,0 +1,134 @@ +--- +sidebar_position: 13 +--- + +# Get dialog + Get chat data by ID + + + +`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat" + FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.GetDialog(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + + Result = OPI_Bitrix24.GetDialog(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetDialog --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": { + "id": 10, + "parent_chat_id": 0, + "parent_message_id": 0, + "name": "", + "description": "", + "owner": 10, + "extranet": false, + "avatar": "", + "color": "#ab7761", + "type": "private", + "counter": 1, + "user_counter": 0, + "message_count": 24, + "unread_id": 3854, + "restrictions": { + "avatar": true, + "rename": true, + "extend": true, + "call": true, + "mute": true, + "leave": true, + "leave_owner": true, + "send": true, + "user_list": true + }, + "last_message_id": 5262, + "last_id": 3852, + "marked_id": 0, + "disk_folder_id": 0, + "entity_type": "", + "entity_id": "", + "entity_data_1": "", + "entity_data_2": "", + "entity_data_3": "", + "mute_list": [], + "date_create": "2024-06-15T16:48:49+00:00", + "message_type": "P", + "disappearing_time": 0, + "public": "", + "role": "member", + "entity_link": { + "type": "", + "url": "" + }, + "permissions": { + "manage_users_add": "member", + "manage_users_delete": "manager", + "manage_ui": "member", + "manage_settings": "owner", + "manage_messages": "member", + "can_post": "member" + }, + "is_new": false, + "readed_list": [ + { + "user_id": 10, + "user_name": "Techno Pizza", + "message_id": 3854, + "date": null + } + ], + "manager_list": [], + "last_message_views": { + "message_id": 5262, + "first_viewers": [], + "count_of_viewers": 0 + }, + "dialog_id": "10" + }, + "time": { + "start": 1720969160.19046, + "finish": 1720969160.22782, + "duration": 0.037362813949585, + "processing": 0.0134620666503906, + "date_start": "2024-07-14T14:59:20+00:00", + "date_finish": "2024-07-14T14:59:20+00:00", + "operating_reset_at": 1720969760, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md new file mode 100644 index 0000000000..81338e7f43 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 3 +--- + +# Leave chat + Removes the current user from the chat room + + + +`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.LeaveChat(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 LeaveChat --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816599.74716, + "finish": 1720816599.81746, + "duration": 0.0702948570251465, + "processing": 0.0438079833984375, + "date_start": "2024-07-12T20:36:39+00:00", + "date_finish": "2024-07-12T20:36:39+00:00", + "operating_reset_at": 1720817199, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md new file mode 100644 index 0000000000..425dfba02f --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 16 +--- + +# Read all + Mark all message as readed + + + +`Function ReadAll(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + + Result = OPI_Bitrix24.ReadAll(URL); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.ReadAll(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 ReadAll --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969176.30834, + "finish": 1720969176.34001, + "duration": 0.0316698551177978, + "processing": 0.00501918792724609, + "date_start": "2024-07-14T14:59:36+00:00", + "date_finish": "2024-07-14T14:59:36+00:00", + "operating_reset_at": 1720969776, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md new file mode 100644 index 0000000000..70c49d8c09 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 15 +--- + +# Send write notification + Send "Writing..." status to dialog..." + + + +`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat" + FunctionParameters["Bitrix24_HookChatID"]; + + Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + + Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SendWritingNotification --url %url% --chat %chat% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969162.6704, + "finish": 1720969162.69719, + "duration": 0.0267889499664307, + "processing": 0.000684022903442383, + "date_start": "2024-07-14T14:59:22+00:00", + "date_finish": "2024-07-14T14:59:22+00:00", + "operating_reset_at": 1720969762, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json new file mode 100644 index 0000000000..92a74ab617 --- /dev/null +++ b/docs/en/md/Bitrix24/Chats-and-dialogs-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Chats and dialogs managment", +"position": "12" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md index f028009831..ade7f308a2 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md @@ -21,7 +21,10 @@ sidebar_position: 3
- +:::tip +Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md index a8509a4d31..7b380a962a 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md @@ -20,7 +20,10 @@ sidebar_position: 7
- +:::tip +Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md index d3c760f698..37b5fe5498 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md @@ -20,7 +20,10 @@ sidebar_position: 8
- +:::tip +Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md index 26e8a8136e..695c39e741 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md @@ -21,7 +21,10 @@ sidebar_position: 5
- +:::tip +Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md index 7701ddd24f..7932d2b331 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md @@ -20,7 +20,10 @@ sidebar_position: 6
- +:::tip +Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md index 54c6c56b51..23a4edf6b3 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md @@ -21,7 +21,10 @@ sidebar_position: 2
- +:::tip +Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md index 1f2629fb86..2471372951 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md @@ -20,7 +20,10 @@ sidebar_position: 1
- +:::tip +Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md index a9b945e97f..ceab0f065d 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md @@ -22,7 +22,10 @@ sidebar_position: 4
- +:::tip +Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json b/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json index cb2da26e66..b7e39f228c 100644 --- a/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json +++ b/docs/en/md/Bitrix24/Comments-and-results-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Comments and results managment", -"position": "5" +"position": "6" } \ No newline at end of file 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 84912fa164..459363c4b6 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Create-post.md @@ -14,7 +14,7 @@ sidebar_position: 1 | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | | Text | --text | String | Text of post | | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | - | Files | --files | String | Attachment data where key > filename, value > file path or binary data | + | Files | --files | Map Of KeyAndValue | Key > file name, value > path or binary data | | Title | --title | String | Post title | | Important | --important | Boolean | Mark post as important | | Token | --token | String | Access token, when not-webhook method used | 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 4ae12e985d..f155727ae2 100644 --- a/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md +++ b/docs/en/md/Bitrix24/Feed-posts-managment/Update-post.md @@ -15,7 +15,7 @@ sidebar_position: 2 | PostID | --postid | String, Number | Post ID | | Text | --text | String | Text of post | | Visibility | --vision | String | Array or 1 recipient: UA all, SGn w. group, Un user, DRn department, Gn group | - | Files | --files | String | Attachment data where key > filename, value > file path or binary data | + | Files | --files | Map Of KeyAndValue | Key > file name, value > path or binary data | | Title | --title | String | Post title | | Token | --token | String | Access token, when not-webhook method used | diff --git a/docs/en/md/Bitrix24/File-managment/Delete-file.md b/docs/en/md/Bitrix24/File-managment/Delete-file.md new file mode 100644 index 0000000000..2796a31af9 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Delete-file.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 4 +--- + +# Delete file + Delete file by ID + + + +`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | ID of removing file | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + FileID = "488"; + + Result = OPI_Bitrix24.DeleteFile(URL, FileID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + FileID = "478"; + + Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteFile --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1718783933.86753, + "finish": 1718783937.64223, + "duration": 3.77469992637634, + "processing": 3.73617887496948, + "date_start": "2024-06-19T07:58:53+00:00", + "date_finish": "2024-06-19T07:58:57+00:00", + "operating_reset_at": 1718784533, + "operating": 3.73615193367004 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md new file mode 100644 index 0000000000..588a29df03 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Get-file-external-link.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 5 +--- + +# Get external link for a file + Get external link to file + + + +`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/File-managment/Get-file-information.md b/docs/en/md/Bitrix24/File-managment/Get-file-information.md new file mode 100644 index 0000000000..32c5d782c8 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Get-file-information.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 3 +--- + +# Get information about file + Get information about file by ID + + + +`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/File-managment/Make-file-copy.md b/docs/en/md/Bitrix24/File-managment/Make-file-copy.md new file mode 100644 index 0000000000..2243cf0e6e --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Make-file-copy.md @@ -0,0 +1,90 @@ +--- +sidebar_position: 8 +--- + +# Copy file + Copy file from one destination to another + + + +`Function MakeFileCopy(Val URL, Val FileID, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | Original file ID | + | FolderID | --folderid | String, Number | ID of copy destination folder | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) +::: +
+ + +```bsl title="Code example" + FolderID = "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/File-managment/Mark-file-as-deleted.md b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md new file mode 100644 index 0000000000..faac0f1c75 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 6 +--- + +# Mark file as deleted + Move file to recycle bin + + + +`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/File-managment/Move-file-to-folder.md b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md new file mode 100644 index 0000000000..dd236da6e4 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md @@ -0,0 +1,90 @@ +--- +sidebar_position: 9 +--- + +# Move file + Move file from one destination to another + + + +`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File ID | + | FolderID | --folderid | String, Number | ID of new destination folder | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) +::: +
+ + +```bsl title="Code example" + FolderID = "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/File-managment/Rename-file.md b/docs/en/md/Bitrix24/File-managment/Rename-file.md new file mode 100644 index 0000000000..3ff3f514e4 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Rename-file.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 10 +--- + +# Rename file + Changes the name of an existing file + + + +`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Name | --title | String | New folders name | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New file name.jpg"; + Filename2 = "New file name 2.jpg"; + + FileID2 = "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/File-managment/Restore-file.md b/docs/en/md/Bitrix24/File-managment/Restore-file.md new file mode 100644 index 0000000000..5f93948b4f --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Restore-file.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 7 +--- + +# Restore file + Restore file from recycle bin + + + +`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | FileID | --fileid | String, Number | File identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/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/File-managment/Upload-file-to-folder.md b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md new file mode 100644 index 0000000000..3fea456b50 --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 2 +--- + +# Upload file to the folder + Upload local file to the folder + + + +`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | File name with extension | + | File | --file | String, BinaryData | File for upload | + | FolderID | --folderid | String | Folder identifier | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) +::: +
+ + +```bsl title="Code example" + Filename2 = "Picture2.jpg"; + Name = "Picture1.jpg"; + + Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data + Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data + + DestinationID = "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/File-managment/Upload-file-to-storage.md b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md new file mode 100644 index 0000000000..e98a5d6edc --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md @@ -0,0 +1,94 @@ +--- +sidebar_position: 1 +--- + +# Upload file to a storage + Upload file to storage root + + + +`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | File name with extension | + | File | --file | String, BinaryData | File for upload | + | StorageID | --storageid | String | Storage id | + | Rights | --rights | String | Rights array if required | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) +::: +
+ + +```bsl title="Code example" + Filename2 = "Picture2.jpg"; + Name = "Picture1.jpg"; + + Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data + Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data + + DestinationID = 3; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID); + + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UploadFileToStorage --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 356, + "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 404, + "SIZE": "26", + "CREATE_TIME": "2024-06-19T07:58:50+00:00", + "UPDATE_TIME": "2024-06-19T07:58:50+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" + }, + "time": { + "start": 1718783929.8197, + "finish": 1718783930.09911, + "duration": 0.279407024383545, + "processing": 0.227760076522827, + "date_start": "2024-06-19T07:58:49+00:00", + "date_finish": "2024-06-19T07:58:50+00:00", + "operating_reset_at": 1718784529, + "operating": 0.227726936340332 + } +} +``` diff --git a/docs/en/md/Bitrix24/File-managment/_category_.json b/docs/en/md/Bitrix24/File-managment/_category_.json new file mode 100644 index 0000000000..aacb9c020c --- /dev/null +++ b/docs/en/md/Bitrix24/File-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "File managment", +"position": "11" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md index f6219ce1e2..3cd5225c0a 100644 --- a/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md @@ -24,7 +24,10 @@ sidebar_position: 1
- +:::tip +Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md index f25937970b..b09de43ebf 100644 --- a/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- # ID of the stage to be deleted @@ -21,7 +21,10 @@ sidebar_position: 2
- +:::tip +Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md index 2ddc5cdaf7..25376343cb 100644 --- a/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md +++ b/docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # Get kanban stages @@ -21,7 +21,10 @@ sidebar_position: 3
- +:::tip +Method at API documentation: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) +::: +
```bsl title="Code example" @@ -517,7 +520,7 @@ sidebar_position: 3 }, "2": { "ID": "2", - "TITLE": "Not withplanandроinаны", + "TITLE": "Not planned", "SORT": "4000", "COLOR": "00C4FB", "SYSTEM_TYPE": "", @@ -529,7 +532,7 @@ sidebar_position: 3 }, "4": { "ID": "4", - "TITLE": "Сделаю to notделе", + "TITLE": "For this week", "SORT": "4100", "COLOR": "47D1E2", "SYSTEM_TYPE": "", diff --git a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md index 454e3e7fe2..340dc89e0e 100644 --- a/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md +++ b/docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Move task to kanban stage @@ -23,7 +23,10 @@ sidebar_position: 4
- +:::tip +Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md new file mode 100644 index 0000000000..4b74ba77da --- /dev/null +++ b/docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 2 +--- + +# Change kanban stage + Changes the properties of the existing kanban or My plan stage + + + +`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Name | --title | String | New stages name | + | StageID | --stage | String, Number | Stage ID for change | + | Color | --color | String | HEX of new stage color | + | PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted | + | AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) +::: +
+ + +```bsl title="Code example" + Name = "New stage name"; + Color = "000000"; + StageID = FunctionParameters["Bitrix24_HookStageID"]; + + URL = FunctionParameters["Bitrix24_URL"]; + + Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color); + + + Name = "New stage name 2"; + Color = "000000"; + StageID = FunctionParameters["Bitrix24_StageID"]; + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateKanbansStage --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816577.57757, + "finish": 1720816577.66624, + "duration": 0.0886678695678711, + "processing": 0.059006929397583, + "date_start": "2024-07-12T20:36:17+00:00", + "date_finish": "2024-07-12T20:36:17+00:00", + "operating_reset_at": 1720817177, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Kanban/_category_.json b/docs/en/md/Bitrix24/Kanban/_category_.json index 1213e3f67d..bdcf391743 100644 --- a/docs/en/md/Bitrix24/Kanban/_category_.json +++ b/docs/en/md/Bitrix24/Kanban/_category_.json @@ -1,4 +1,4 @@ { "label": "Kanban", -"position": "6" +"position": "7" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Message-management/Delete-message.md b/docs/en/md/Bitrix24/Message-management/Delete-message.md new file mode 100644 index 0000000000..90486d53e3 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Delete-message.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 4 +--- + +# Delete message + Deletes a dialog message + + + +`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | ID of the message to be deleted | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + MessageID = FunctionParameters["Bitrix24_ChatMessageID"]; + + Result = OPI_Bitrix24.DeleteMessage(URL, MessageID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + MessageID = FunctionParameters["Bitrix24_UserMessageID"]; + + Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteMessage --url %url% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969167.77137, + "finish": 1720969167.82331, + "duration": 0.051936149597168, + "processing": 0.0215229988098145, + "date_start": "2024-07-14T14:59:27+00:00", + "date_finish": "2024-07-14T14:59:27+00:00", + "operating_reset_at": 1720969767, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Edit-message.md b/docs/en/md/Bitrix24/Message-management/Edit-message.md new file mode 100644 index 0000000000..9ecb48f039 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Edit-message.md @@ -0,0 +1,76 @@ +--- +sidebar_position: 2 +--- + +# Edit message + Edit dialog message content + + + +`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | ID of the message to be edited | + | Text | --text | String | New message text | + | Attachments | --blocks | Array of Structure | New blocks array | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + MessageID = FunctionParameters["Bitrix24_ChatMessageID"]; + + Text = "New message text"; + + Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + MessageID = FunctionParameters["Bitrix24_UserMessageID"]; + + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); + + Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 EditMessage --url %url% --message %message% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969165.17314, + "finish": 1720969165.21621, + "duration": 0.0430619716644287, + "processing": 0.018265962600708, + "date_start": "2024-07-14T14:59:25+00:00", + "date_finish": "2024-07-14T14:59:25+00:00", + "operating_reset_at": 1720969765, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Get-file-block.md b/docs/en/md/Bitrix24/Message-management/Get-file-block.md new file mode 100644 index 0000000000..3ed6fc6b84 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Get-file-block.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 9 +--- + +# Get file block + Make file block for SendMessage method + + + +`Function GetFileBlock(Val Name, Val URL) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Picture name | + | URL | --url | String | File URL | + + + Returns: Structure - FileBlock + +
+ +:::tip +Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="CLI command example" + + oint bitrix24 GetFileBlock --title %title% --url %url% + +``` + + diff --git a/docs/en/md/Bitrix24/Message-management/Get-picture-block.md b/docs/en/md/Bitrix24/Message-management/Get-picture-block.md new file mode 100644 index 0000000000..c61c052cc1 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Get-picture-block.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 8 +--- + +# Get picture block + Make picture block for SendMessage method + + + +`Function GetPictureBlock(Val Name, Val URL) Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | Name | --title | String | Picture name | + | URL | --url | String | URL of sending picture | + + + Returns: Structure - PictureBlock + +
+ +:::tip +Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="CLI command example" + + oint bitrix24 GetPictureBlock --title %title% --url %url% + +``` + + diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md new file mode 100644 index 0000000000..4d8109148c --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 6 +--- + +# Mark message as readed + Mark current and all previous messages as readed + + + +`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | MessageID | --message | String, Number | Id of last readed message | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat" + FunctionParameters["Bitrix24_HookChatID"]; + MessageID = FunctionParameters["Bitrix24_ChatMessageID"]; + + Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + MessageID = FunctionParameters["Bitrix24_UserMessageID"]; + + Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID,Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MarkMessageAsReaded --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": { + "dialogId": 10, + "chatId": 10, + "lastId": 5262, + "counter": 0 + }, + "time": { + "start": 1720969157.61149, + "finish": 1720969157.65659, + "duration": 0.0451040267944336, + "processing": 0.0171201229095459, + "date_start": "2024-07-14T14:59:17+00:00", + "date_finish": "2024-07-14T14:59:17+00:00", + "operating_reset_at": 1720969757, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md new file mode 100644 index 0000000000..5c7f629b24 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 7 +--- + +# Mark message as unreaded + Mark current and all messages after as unreaded + + + +`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | MessageID | --message | String, Number | ID of last unreaded message | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat" + FunctionParameters["Bitrix24_HookChatID"]; + MessageID = FunctionParameters["Bitrix24_ChatMessageID"]; + + Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + MessageID = FunctionParameters["Bitrix24_UserMessageID"]; + + Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 MarkMessageAsUnreaded --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969158.8803, + "finish": 1720969158.91584, + "duration": 0.035538911819458, + "processing": 0.0112378597259521, + "date_start": "2024-07-14T14:59:18+00:00", + "date_finish": "2024-07-14T14:59:18+00:00", + "operating_reset_at": 1720969758, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-file.md b/docs/en/md/Bitrix24/Message-management/Send-file.md new file mode 100644 index 0000000000..9488201795 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Send-file.md @@ -0,0 +1,144 @@ +--- +sidebar_position: 5 +--- + +# SendFile + Send disk file to chat + + + +`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID | + | FileID | --fileid | String, Number | File ID from UploadFileToFolder method | + | Description | --description | String | File description | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = FunctionParameters["Bitrix24_HookChatID"]; + File = FunctionParameters["Document"]; // Binary Data, URL or path to file + Description = "Very important file"; + + Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID); + FolderID = Directory["result"]["ID"]; + + UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID); + FileID = UploadedFile["result"]["ID"]; + + Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + ChatID = FunctionParameters["Bitrix24_ChatID"]; + + Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token); + FolderID = Directory["result"]["ID"]; + + UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token); + FileID = UploadedFile["result"]["ID"]; + + Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SendFile --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% + +``` + +```json title="Result" +{ + "result": { + "FILES": { + "upload3254": { + "id": 3254, + "chatId": 254, + "date": {}, + "type": "file", + "name": "Imortant doc.docx", + "extension": "docx", + "size": 24071, + "image": false, + "status": "done", + "progress": 100, + "authorId": 1, + "authorName": "Anton Titovets", + "urlPreview": "", + "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerAttrs": { + "viewer": null, + "viewerType": "cloud-document", + "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", + "viewerSeparateItem": true, + "viewerExtension": "im.integration.viewer", + "objectId": "3254", + "imChatId": 254, + "title": "Imortant doc.docx", + "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Save to Bitrix24 Drive\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" + } + } + }, + "DISK_ID": [ + "3254" + ], + "FILE_MODELS": { + "upload3254": { + "id": 3254, + "name": "Imortant doc.docx", + "createTime": {}, + "updateTime": {}, + "deleteTime": null, + "code": null, + "xmlId": null, + "storageId": 6, + "realObjectId": 3254, + "parentId": 3250, + "deletedType": 0, + "createdBy": "1", + "updatedBy": "1", + "deletedBy": "0", + "typeFile": 4, + "globalContentVersion": 2, + "fileId": 2330, + "size": 24071, + "etag": "1179305ea90d0b0fef106e1163deaeb8", + "links": { + "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254", + "showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1" + } + } + }, + "MESSAGE_ID": 5346 + }, + "time": { + "start": 1720969175.0006, + "finish": 1720969175.09084, + "duration": 0.0902431011199951, + "processing": 0.0652461051940918, + "date_start": "2024-07-14T14:59:35+00:00", + "date_finish": "2024-07-14T14:59:35+00:00", + "operating_reset_at": 1720969775, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Send-message.md b/docs/en/md/Bitrix24/Message-management/Send-message.md new file mode 100644 index 0000000000..e61951385b --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Send-message.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 1 +--- + +# Send message + Send message to dialog + + + +`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) | + | Text | --text | String | Message text | + | Attachments | --blocks | Array of Structure | Array of attachments | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + ChatID = "chat" + FunctionParameters["Bitrix24_HookChatID"]; + Text = "Message text"; + Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Attachments = New Array; + Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image)); + Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File)); + + Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments); + + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + UserID = 10; + + Result = OPI_Bitrix24.SendMessage(URL, UserID, Text,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SendMessage --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Result" +{ + "result": 5342, + "time": { + "start": 1720969163.89343, + "finish": 1720969163.95538, + "duration": 0.061945915222168, + "processing": 0.0366020202636719, + "date_start": "2024-07-14T14:59:23+00:00", + "date_finish": "2024-07-14T14:59:23+00:00", + "operating_reset_at": 1720969763, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md new file mode 100644 index 0000000000..d8aad51282 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/Set-message-reaction.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 3 +--- + +# Set message reaction + Set or remove reaction mark on the message + + + +`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | MessageID | --message | String, Number | Message ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + MessageID = FunctionParameters["Bitrix24_ChatMessageID"]; + + Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + MessageID = FunctionParameters["Bitrix24_UserMessageID"]; + + Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 SetMessageReaction --url %url% --message %message% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720969166.51361, + "finish": 1720969166.55322, + "duration": 0.0396139621734619, + "processing": 0.0151541233062744, + "date_start": "2024-07-14T14:59:26+00:00", + "date_finish": "2024-07-14T14:59:26+00:00", + "operating_reset_at": 1720969766, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Message-management/_category_.json b/docs/en/md/Bitrix24/Message-management/_category_.json new file mode 100644 index 0000000000..15858a40d2 --- /dev/null +++ b/docs/en/md/Bitrix24/Message-management/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Message management", +"position": "13" +} \ No newline at end of file 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 300185e9f7..e16be17d7e 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", +"label": "Работа с диском и файлами", "position": "7" } \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md new file mode 100644 index 0000000000..5a95a11586 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 6 +--- + +# Create folder at the storage + Create new foldera at the storage + + + +`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String | Storage ID | + | Name | --title | String | Folder name | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) +::: +
+ + +```bsl title="Code example" + StorageID = 3; + Name = "New catalog"; + Filename2 = "New folder 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2); + + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CreateStorageFolder --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": 574, + "NAME": "New catalog", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 574, + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-06-22T09:07:36+00:00", + "UPDATE_TIME": "2024-06-22T09:07:36+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog" + }, + "time": { + "start": 1719047256.22025, + "finish": 1719047256.27758, + "duration": 0.057330846786499, + "processing": 0.0276291370391846, + "date_start": "2024-06-22T09:07:36+00:00", + "date_finish": "2024-06-22T09:07:36+00:00", + "operating_reset_at": 1719047856, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md new file mode 100644 index 0000000000..f77de117b4 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 2 +--- + +# Get storage for application data + Get information about storage with which the application can work to store its data + + + +`Function GetAppSotrage(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) +::: +
+ + +```bsl title="Code example" + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetAppSotrage(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetAppSotrage --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + + diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md new file mode 100644 index 0000000000..63743cbd4d --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md @@ -0,0 +1,105 @@ +--- +sidebar_position: 5 +--- + +# Get a list of child storage objects + Get a list of files and folders, located at the root of the storage + + + +`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + StorageID = 3; + Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetStorageObjects --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "568", + "NAME": "Picture2.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "558", + "SIZE": "2114023", + "CREATE_TIME": "2024-06-22T09:07:30+00:00", + "UPDATE_TIME": "2024-06-22T09:07:30+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg" + }, + { + "ID": "570", + "NAME": "Picture1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "560", + "SIZE": "805189", + "CREATE_TIME": "2024-06-22T09:07:32+00:00", + "UPDATE_TIME": "2024-06-22T09:07:32+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg" + } + ], + "total": 2, + "time": { + "start": 1719047253.42516, + "finish": 1719047253.47205, + "duration": 0.0468947887420654, + "processing": 0.016359806060791, + "date_start": "2024-06-22T09:07:33+00:00", + "date_finish": "2024-06-22T09:07:33+00:00", + "operating_reset_at": 1719047853, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storage.md b/docs/en/md/Bitrix24/Storages-managment/Get-storage.md new file mode 100644 index 0000000000..572be3101a --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storage.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 3 +--- + +# Get storage + Get information about storage + + + +`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + StorageID = 3; + + Result = OPI_Bitrix24.GetStorage(URL, StorageID); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetStorage --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "3", + "NAME": "Main drive", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + "time": { + "start": 1719047247.65416, + "finish": 1719047247.68963, + "duration": 0.0354659557342529, + "processing": 0.00417995452880859, + "date_start": "2024-06-22T09:07:27+00:00", + "date_finish": "2024-06-22T09:07:27+00:00", + "operating_reset_at": 1719047847, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md new file mode 100644 index 0000000000..7c9fcd1657 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md @@ -0,0 +1,126 @@ +--- +sidebar_position: 1 +--- + +# Get list of storages + Get list of available files storages + + + +`Function GetStoragesList(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) +::: +
+ + +```bsl title="Code example" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + Result = OPI_Bitrix24.GetStoragesList(URL); + + + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + + Result = OPI_Bitrix24.GetStoragesList(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetStoragesList --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "3", + "NAME": "Main drive", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + { + "ID": "1", + "NAME": "Anton Titovets", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "1", + "ROOT_OBJECT_ID": "1" + }, + { + "ID": "16", + "NAME": "iscript13@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "10", + "ROOT_OBJECT_ID": "270" + }, + { + "ID": "4", + "NAME": "Payment Processing Customer Support", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "4" + }, + { + "ID": "10", + "NAME": "CoPilot", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "4", + "ROOT_OBJECT_ID": "52" + }, + { + "ID": "12", + "NAME": "Support Bitrix24", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "6", + "ROOT_OBJECT_ID": "70" + }, + { + "ID": "14", + "NAME": "Marta", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "8", + "ROOT_OBJECT_ID": "72" + } + ], + "total": 7, + "time": { + "start": 1718783911.64028, + "finish": 1718783911.69026, + "duration": 0.0499801635742188, + "processing": 0.00660109519958496, + "date_start": "2024-06-19T07:58:31+00:00", + "date_finish": "2024-06-19T07:58:31+00:00", + "operating_reset_at": 1718784511, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md new file mode 100644 index 0000000000..642bd4a6bd --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/Rename-storage.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 4 +--- + +# Rename storage + Change storage name (for app storage only, see. GetAppStorage) + + + +`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | StorageID | --storageid | String, Number | Storage ID | + | Name | --title | String | New storage name | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) +::: +
+ + +```bsl title="Code example" + Name = "New storage name"; + URL = "b24-ar17wx.bitrix24.by"; + Token = "b9df7366006e9f06006b12e400000001000..."; + StorageID = "18"; + + Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RenameStorage --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Result" +{ + "result": { + "ID": "18", + "NAME": "New storage name", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1719047246.29499, + "finish": 1719047246.35783, + "duration": 0.062842845916748, + "processing": 0.0317339897155762, + "date_start": "2024-06-22T09:07:26+00:00", + "date_finish": "2024-06-22T09:07:26+00:00", + "operating_reset_at": 1719047846, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Storages-managment/_category_.json b/docs/en/md/Bitrix24/Storages-managment/_category_.json new file mode 100644 index 0000000000..f70c92fb14 --- /dev/null +++ b/docs/en/md/Bitrix24/Storages-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Storages managment", +"position": "9" +} \ No newline at end of file diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md new file mode 100644 index 0000000000..f5030caceb --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md @@ -0,0 +1,71 @@ +--- +sidebar_position: 1 +--- + +# Add tasks checklist element + Adds new element of tasks checklist + + + +`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Text | --text | String | Text (title) of checklist element | + | Completed | --complete | Boolean | Mark as completed | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + + Text = "Checklist element"; + + Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True); + + + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + TaskID = FunctionParameters["Bitrix24_TaskID"]; + + Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text,, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddTasksChecklistElement --url %url% --task %task% --text %text% --complete %complete% --token %token% + +``` + +```json title="Result" +{ + "result": 96, + "time": { + "start": 1720816505.3041, + "finish": 1720816505.37014, + "duration": 0.0660440921783447, + "processing": 0.0380921363830566, + "date_start": "2024-07-12T20:35:05+00:00", + "date_finish": "2024-07-12T20:35:05+00:00", + "operating_reset_at": 1720817105, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md new file mode 100644 index 0000000000..8902d19091 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 6 +--- + +# Complete tasks checklist element + Mark an element as completed + + + +`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + ElementID = FunctionParameters["Bitrix24_HookCheckElementID"]; + + Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID); + + + TaskID = FunctionParameters["Bitrix24_TaskID"]; + ElementID = FunctionParameters["Bitrix24_CheckElementID"]; + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 CompleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816509.8981, + "finish": 1720816509.94922, + "duration": 0.0511200428009033, + "processing": 0.0246191024780273, + "date_start": "2024-07-12T20:35:09+00:00", + "date_finish": "2024-07-12T20:35:09+00:00", + "operating_reset_at": 1720817109, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md new file mode 100644 index 0000000000..e502415956 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 3 +--- + +# Delete tasks checklist element + Deletes element from tasks checklist + + + +`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | ID of deleted element | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + ElementID = FunctionParameters["Bitrix24_HookCheckElementID"]; + + Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID); + + + TaskID = FunctionParameters["Bitrix24_TaskID"]; + ElementID = FunctionParameters["Bitrix24_CheckElementID"]; + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816512.25818, + "finish": 1720816512.30984, + "duration": 0.0516610145568848, + "processing": 0.0264489650726318, + "date_start": "2024-07-12T20:35:12+00:00", + "date_finish": "2024-07-12T20:35:12+00:00", + "operating_reset_at": 1720817112, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md new file mode 100644 index 0000000000..3cf9ff32d4 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 5 +--- + +# Get tasks checklist element + Gets tasks checklist element by ID + + + +`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + ElementID = FunctionParameters["Bitrix24_HookCheckElementID"]; + + Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID); + + + TaskID = FunctionParameters["Bitrix24_TaskID"]; + ElementID = FunctionParameters["Bitrix24_CheckElementID"]; + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "New elements text", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + "time": { + "start": 1720816508.81324, + "finish": 1720816508.85536, + "duration": 0.0421209335327148, + "processing": 0.0174088478088379, + "date_start": "2024-07-12T20:35:08+00:00", + "date_finish": "2024-07-12T20:35:08+00:00", + "operating_reset_at": 1720817108, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md new file mode 100644 index 0000000000..f86f003cfb --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md @@ -0,0 +1,95 @@ +--- +sidebar_position: 4 +--- + +# Get tasks checklist + Gets the list of elements on the task checklist + + + +`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + + Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID); + + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + TaskID = FunctionParameters["Bitrix24_TaskID"]; + + Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTasksChecklist --url %url% --task %task% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "94", + "TASK_ID": "632", + "PARENT_ID": 0, + "CREATED_BY": "1", + "TITLE": "BX_CHECKLIST_1", + "SORT_INDEX": "0", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "New elements text", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + } + ], + "time": { + "start": 1720816507.68937, + "finish": 1720816507.74166, + "duration": 0.0522880554199219, + "processing": 0.0231881141662598, + "date_start": "2024-07-12T20:35:07+00:00", + "date_finish": "2024-07-12T20:35:07+00:00", + "operating_reset_at": 1720817107, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md new file mode 100644 index 0000000000..12f172e0b5 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 7 +--- + +# Renew tasks checklist element + Unmark an element as completed + + + +`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Element ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + ElementID = FunctionParameters["Bitrix24_HookCheckElementID"]; + + Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID); + + + TaskID = FunctionParameters["Bitrix24_TaskID"]; + ElementID = FunctionParameters["Bitrix24_CheckElementID"]; + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 RenewTasksChecklistElement --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Result" +{ + "result": true, + "time": { + "start": 1720816511.09347, + "finish": 1720816511.14508, + "duration": 0.051609992980957, + "processing": 0.0250108242034912, + "date_start": "2024-07-12T20:35:11+00:00", + "date_finish": "2024-07-12T20:35:11+00:00", + "operating_reset_at": 1720817111, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md new file mode 100644 index 0000000000..3091b4e65f --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 2 +--- + +# Update tasks checklist element + Updates text of element of tasks checklist + + + +`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | Number, String | Task ID | + | ElementID | --element | Number, String | Checklist element ID | + | Text | --text | String | Text (title) of checklist element | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_HookTaskID"]; + ElementID = FunctionParameters["Bitrix24_HookCheckElementID"]; + + Text = "New elements text"; + + Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text); + + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + TaskID = FunctionParameters["Bitrix24_TaskID"]; + ElementID = FunctionParameters["Bitrix24_CheckElementID"]; + + Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateTasksChecklistElement --url %url% --task %task% --element %element% --text %text% --token %token% + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720816506.52861, + "finish": 1720816506.58416, + "duration": 0.0555450916290283, + "processing": 0.027979850769043, + "date_start": "2024-07-12T20:35:06+00:00", + "date_finish": "2024-07-12T20:35:06+00:00", + "operating_reset_at": 1720817106, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json b/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json new file mode 100644 index 0000000000..9bee02cfc6 --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-checklists-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Tasks checklists managment", +"position": "5" +} \ 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 aba1f72156..2654ddfe06 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 @@ -20,7 +20,10 @@ sidebar_position: 17
- +:::tip +Method at API documentation: [tasks.task.favorite.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_add.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md index 30cefe263c..6dd53bd26e 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Approve-task.md @@ -20,7 +20,10 @@ sidebar_position: 7
- +:::tip +Method at API documentation: [tasks.task.approve](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_approve.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md index d7ce49dc74..c7bdb717e9 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md @@ -21,7 +21,10 @@ sidebar_position: 6
- +:::tip +Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md index 65611f6d4d..546d9a471c 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md @@ -21,7 +21,10 @@ sidebar_position: 20
- +:::tip +Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md index 7c4a61d4f8..462c6d4de5 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Complete-task.md @@ -20,7 +20,10 @@ sidebar_position: 9
- +:::tip +Method at API documentation: [tasks.task.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_complete.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-task.md b/docs/en/md/Bitrix24/Tasks-managment/Create-task.md index 2eedbc739c..5546a9df19 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Create-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-task.md @@ -20,7 +20,10 @@ sidebar_position: 3
- +:::tip +Method at API documentation: [tasks.task.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_add.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md index 1cdb7dbbef..4b72a47687 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md @@ -22,7 +22,10 @@ sidebar_position: 23
- +:::tip +Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md index 978fa02b20..89a7a1f954 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Defer-task.md @@ -20,7 +20,10 @@ sidebar_position: 11
- +:::tip +Method at API documentation: [tasks.task.defer](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_defer.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md index bd8e0a2afe..637cb2ca65 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Delegate-task.md @@ -21,7 +21,10 @@ sidebar_position: 16
- +:::tip +Method at API documentation: [tasks.task.delegate](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delegate.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md index d0b53560d2..16cc7ca03a 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-task.md @@ -20,7 +20,10 @@ sidebar_position: 5
- +:::tip +Method at API documentation: [tasks.task.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delete.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md index 1bf55bde6d..b562d39148 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md @@ -22,7 +22,10 @@ sidebar_position: 24
- +:::tip +Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) +::: +
@@ -34,4 +37,18 @@ sidebar_position: 24 ``` - +```json title="Result" +{ + "result": [], + "time": { + "start": 1720816479.3837, + "finish": 1720816479.41872, + "duration": 0.0350160598754883, + "processing": 0.00787091255187988, + "date_start": "2024-07-12T20:34:39+00:00", + "date_finish": "2024-07-12T20:34:39+00:00", + "operating_reset_at": 1720817079, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md index 5b126b47a8..ee538f7313 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Disapprove-task.md @@ -20,7 +20,10 @@ sidebar_position: 8
- +:::tip +Method at API documentation: [tasks.task.disapprove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_disapprove.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md new file mode 100644 index 0000000000..279eaf759c --- /dev/null +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 25 +--- + +# Get users daily tasks plan + Gets the task plan for the current users day + + + +`Function GetDailyPlan(Val URL, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + + Result = OPI_Bitrix24.GetDailyPlan(URL); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.GetDailyPlan(URL, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetDailyPlan --url %url% --token %token% + +``` + +```json title="Result" +{ + "result": [], + "time": { + "start": 1720816513.42336, + "finish": 1720816513.45192, + "duration": 0.0285580158233643, + "processing": 0.000265121459960938, + "date_start": "2024-07-12T20:35:13+00:00", + "date_finish": "2024-07-12T20:35:13+00:00", + "operating_reset_at": 1720817113, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task-fields-structure.md index dcd8ee15a4..5ce8551fa2 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,5 +1,5 @@ --- -sidebar_position: 25 +sidebar_position: 26 --- # Get task fields structure @@ -19,7 +19,10 @@ sidebar_position: 25
- +:::tip +Method at API documentation: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php) +::: +
```bsl title="Code example" 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 10c6660736..07d744bb0b 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task-history.md @@ -20,7 +20,10 @@ sidebar_position: 19
- +:::tip +Method at API documentation: [tasks.task.history.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_history_list.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Get-task.md b/docs/en/md/Bitrix24/Tasks-managment/Get-task.md index 85cd1af7bb..6a48aed8a8 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-task.md @@ -20,7 +20,10 @@ sidebar_position: 1
- +:::tip +Method at API documentation: [tasks.task.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_get.php) +::: +
```bsl title="Code example" 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 9702148237..baa1ea6812 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,5 +1,5 @@ --- -sidebar_position: 26 +sidebar_position: 27 --- # Get structure of tasks filter 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 487e829756..afba1a1dd0 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Get-tasks-list.md @@ -21,7 +21,10 @@ sidebar_position: 2
- +:::tip +Method at API documentation: [tasks.task.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md index 5940c0fdf8..9526423bc7 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Mute-task.md @@ -20,7 +20,10 @@ sidebar_position: 21
- +:::tip +Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md index 8ca96b043e..6693ec21ae 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Pause-task.md @@ -20,7 +20,10 @@ sidebar_position: 12
- +:::tip +Method at API documentation: [tasks.task.pause](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_pause.php) +::: +
```bsl title="Code example" 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 84a03872a8..5944e213a6 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 @@ -20,7 +20,10 @@ sidebar_position: 18
- +:::tip +Method at API documentation: [tasks.task.favorite.remove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_remove.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md index bb658edb2f..529c0cffe0 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Renew-task.md @@ -20,7 +20,10 @@ sidebar_position: 10
- +:::tip +Method at API documentation: [tasks.task.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_renew.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Start-task.md b/docs/en/md/Bitrix24/Tasks-managment/Start-task.md index 28e9bbbd7f..4352c88735 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Start-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Start-task.md @@ -20,7 +20,10 @@ sidebar_position: 13
- +:::tip +Method at API documentation: [tasks.task.start](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_start.php) +::: +
```bsl title="Code example" 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 cb4a7265d2..b23ee21df7 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Start-watching-task.md @@ -20,7 +20,10 @@ sidebar_position: 14
- +:::tip +Method at API documentation: [tasks.task.startwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_startwatch.php) +::: +
```bsl title="Code example" 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 36b1080a45..fc41eb6d2c 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Stop-watching-task.md @@ -20,7 +20,10 @@ sidebar_position: 15
- +:::tip +Method at API documentation: [tasks.task.stopwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_stopwatch.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md index 8c5d76e1d8..a239154cb1 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md @@ -20,7 +20,10 @@ sidebar_position: 22
- +:::tip +Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Tasks-managment/Update-task.md b/docs/en/md/Bitrix24/Tasks-managment/Update-task.md index 2d99a9dace..5753ae2daa 100644 --- a/docs/en/md/Bitrix24/Tasks-managment/Update-task.md +++ b/docs/en/md/Bitrix24/Tasks-managment/Update-task.md @@ -21,7 +21,10 @@ sidebar_position: 4
- +:::tip +Method at API documentation: [tasks.task.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_update.php) +::: +
```bsl title="Code example" diff --git a/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md new file mode 100644 index 0000000000..479b60ffc5 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 1 +--- + +# Add task time accounting + Adds information about the user's time spent to the task + + + +`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task for time accounting | + | Time | --amount | String, Number | Time spent in seconds | + | UserID | --user | String, Number | ID of user for time accounting | + | Text | --text | String | Comment text | + | SetupDate | --date | String | Date the record was set | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_ElapsedTaskID"]; + + Time = 3600; + + Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time); + + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Text = "Time spent on work"; + UserID = 10; + Time = 7200; + SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); + + Result = OPI_Bitrix24.AddTaskTimeAccounting(URL +, TaskID +, Time +, UserID +, Text +, SetupDate +, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 AddTaskTimeAccounting --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% + +``` + +```json title="Result" +{ + "result": 42, + "time": { + "start": 1720816582.16849, + "finish": 1720816582.22964, + "duration": 0.0611569881439209, + "processing": 0.0315871238708496, + "date_start": "2024-07-12T20:36:22+00:00", + "date_finish": "2024-07-12T20:36:22+00:00", + "operating_reset_at": 1720817182, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md new file mode 100644 index 0000000000..a6fb41043b --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 2 +--- + +# Delete task time accounting + Deletes record of time accounting + + + +`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | ID of task for time accounting | + | RecordID | --record | String, Number | Time record ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_ElapsedTaskID"]; + RecordID = FunctionParameters["Bitrix24_HookTimeID"]; + + Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + RecordID = FunctionParameters["Bitrix24_TimeID"]; + + Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 DeleteTaskTimeAccounting --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720816586.91135, + "finish": 1720816586.96255, + "duration": 0.0512039661407471, + "processing": 0.0238111019134522, + "date_start": "2024-07-12T20:36:26+00:00", + "date_finish": "2024-07-12T20:36:26+00:00", + "operating_reset_at": 1720817186, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md new file mode 100644 index 0000000000..19c026417f --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md @@ -0,0 +1,90 @@ +--- +sidebar_position: 3 +--- + +# Get task time accounting list + Get list of time accounting records for task + + + +`Function GetTaskTimeAccountingList(Val URL, Val TaskID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_ElapsedTaskID"]; + + Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + + Result = OPI_Bitrix24.GetTaskTimeAccountingList(URL, TaskID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTaskTimeAccountingList --url %url% --task %task% --token %token% + +``` + +```json title="Result" +{ + "result": [ + { + "ID": "40", + "TASK_ID": "638", + "USER_ID": "1", + "COMMENT_TEXT": "", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-07-12T20:36:21+00:00", + "DATE_START": "2024-07-12T20:36:21+00:00", + "DATE_STOP": "2024-07-12T20:36:21+00:00" + }, + { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Time spent on work", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + } + ], + "total": 2, + "time": { + "start": 1720816584.48831, + "finish": 1720816584.5364, + "duration": 0.0480880737304688, + "processing": 0.0219790935516357, + "date_start": "2024-07-12T20:36:24+00:00", + "date_finish": "2024-07-12T20:36:24+00:00", + "operating_reset_at": 1720817184, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md new file mode 100644 index 0000000000..b72e0b8644 --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Get-task-time-accounting.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 4 +--- + +# Get task time accounting + Get time accounting record data + + + +`Function GetTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | RecordID | --record | String, Number | Time record ID | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_ElapsedTaskID"]; + RecordID = FunctionParameters["Bitrix24_HookTimeID"]; + + Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + RecordID = FunctionParameters["Bitrix24_TimeID"]; + + Result = OPI_Bitrix24.GetTaskTimeAccounting(URL, TaskID, RecordID, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 GetTaskTimeAccounting --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Result" +{ + "result": { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Time spent on work", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + }, + "time": { + "start": 1720816583.31997, + "finish": 1720816583.36716, + "duration": 0.0471861362457275, + "processing": 0.0187540054321289, + "date_start": "2024-07-12T20:36:23+00:00", + "date_finish": "2024-07-12T20:36:23+00:00", + "operating_reset_at": 1720817183, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md new file mode 100644 index 0000000000..5fd19ed27d --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/Update-task-time-accounting.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 5 +--- + +# Update task time accounting + Update time accounting record data + + + +`Function UpdateTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Time, Val Text = "", Val SetupDate = "", Val Token = "") Export` + + | Parameter | CLI option | Type | Destination | + |-|-|-|-| + | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | + | TaskID | --task | String, Number | Task ID | + | RecordID | --record | String, Number | Time record ID | + | Time | --amount | String, Number | Time spent in seconds | + | Text | --text | String | Comment text | + | SetupDate | --date | String | Date the record was set | + | Token | --token | String | Access token, when not-webhook method used | + + + Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API + +
+ +:::tip +Method at API documentation: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) +::: +
+ + +```bsl title="Code example" + URL = FunctionParameters["Bitrix24_URL"]; + TaskID = FunctionParameters["Bitrix24_ElapsedTaskID"]; + RecordID = FunctionParameters["Bitrix24_HookTimeID"]; + + Text = "The text I forgot last time"; + Time = 4800; + + Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL, TaskID, RecordID, Time, Text); + + + URL = FunctionParameters["Bitrix24_Domain"]; + Token = FunctionParameters["Bitrix24_Token"]; + RecordID = FunctionParameters["Bitrix24_TimeID"]; + + Text = "New time record"; + Time = 4800; + SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1); + + Result = OPI_Bitrix24.UpdateTaskTimeAccounting(URL +, TaskID +, RecordID +, Time +, Text +, SetupDate +, Token); +``` + + + +```sh title="CLI command example" + + oint bitrix24 UpdateTaskTimeAccounting --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% + +``` + +```json title="Result" +{ + "result": null, + "time": { + "start": 1720816585.70407, + "finish": 1720816585.77088, + "duration": 0.0668020248413086, + "processing": 0.0276288986206055, + "date_start": "2024-07-12T20:36:25+00:00", + "date_finish": "2024-07-12T20:36:25+00:00", + "operating_reset_at": 1720817185, + "operating": 0 + } +} +``` diff --git a/docs/en/md/Bitrix24/Timekeeping/_category_.json b/docs/en/md/Bitrix24/Timekeeping/_category_.json new file mode 100644 index 0000000000..3486053d6e --- /dev/null +++ b/docs/en/md/Bitrix24/Timekeeping/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Timekeeping", +"position": "8" +} \ No newline at end of file diff --git a/docs/ru/cli/Bitrix24/ВключитьУведомленияЧата.txt b/docs/ru/cli/Bitrix24/ВключитьУведомленияЧата.txt new file mode 100644 index 0000000000..b6e5195afe --- /dev/null +++ b/docs/ru/cli/Bitrix24/ВключитьУведомленияЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ВключитьУведомленияЧата --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ВозобновитьЭлементЧеклистаЗадачи.txt b/docs/ru/cli/Bitrix24/ВозобновитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..944dcd12db --- /dev/null +++ b/docs/ru/cli/Bitrix24/ВозобновитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ВозобновитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% diff --git a/docs/ru/cli/Bitrix24/ВыполнитьЭлементЧеклистаЗадачи.txt b/docs/ru/cli/Bitrix24/ВыполнитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..02e0a5bb01 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ВыполнитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ВыполнитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% diff --git a/docs/ru/cli/Bitrix24/ДобавитьПользователейВЧат.txt b/docs/ru/cli/Bitrix24/ДобавитьПользователейВЧат.txt new file mode 100644 index 0000000000..d0fd3f4ae4 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьПользователейВЧат.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьПользователейВЧат --url %url% --chat %chat% --users %users% --hide %hide% --token %token% diff --git a/docs/ru/cli/Bitrix24/ДобавитьТрудозатратыЗадачи.txt b/docs/ru/cli/Bitrix24/ДобавитьТрудозатратыЗадачи.txt new file mode 100644 index 0000000000..3db0d78637 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьТрудозатратыЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьТрудозатратыЗадачи --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% diff --git a/docs/ru/cli/Bitrix24/ДобавитьЭлементЧеклистаЗадачи.txt b/docs/ru/cli/Bitrix24/ДобавитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..227684a4f9 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ДобавитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ДобавитьЭлементЧеклистаЗадачи --url %url% --task %task% --text %text% --complete %complete% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьЗаголовокЧата.txt b/docs/ru/cli/Bitrix24/ИзменитьЗаголовокЧата.txt new file mode 100644 index 0000000000..7e3bb5a7ee --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьЗаголовокЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьЗаголовокЧата --url %url% --chat %chat% --title %title% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьКартинкуЧата.txt b/docs/ru/cli/Bitrix24/ИзменитьКартинкуЧата.txt new file mode 100644 index 0000000000..26f46602e1 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьКартинкуЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьКартинкуЧата --url %url% --chat %chat% --picture %picture% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьСообщение.txt b/docs/ru/cli/Bitrix24/ИзменитьСообщение.txt new file mode 100644 index 0000000000..9f45e1eace --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьСообщение.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьСообщение --url %url% --message %message% --text %text% --blocks %blocks% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьСтадиюКанбана.txt b/docs/ru/cli/Bitrix24/ИзменитьСтадиюКанбана.txt new file mode 100644 index 0000000000..93a30798c2 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьСтадиюКанбана.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьСтадиюКанбана --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьТрудозатратыЗадачи.txt b/docs/ru/cli/Bitrix24/ИзменитьТрудозатратыЗадачи.txt new file mode 100644 index 0000000000..773623a91e --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьТрудозатратыЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьЦветЧата.txt b/docs/ru/cli/Bitrix24/ИзменитьЦветЧата.txt new file mode 100644 index 0000000000..b3bedc88a9 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьЦветЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьЦветЧата --url %url% --chat %chat% --color %color% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИзменитьЭлементЧеклистаЗадачи.txt b/docs/ru/cli/Bitrix24/ИзменитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..4aec62c7d8 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИзменитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ИзменитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --text %text% --token %token% diff --git a/docs/ru/cli/Bitrix24/ИсключитьПользователяИзЧата.txt b/docs/ru/cli/Bitrix24/ИсключитьПользователяИзЧата.txt new file mode 100644 index 0000000000..55d8af06ae --- /dev/null +++ b/docs/ru/cli/Bitrix24/ИсключитьПользователяИзЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ИсключитьПользователяИзЧата --url %url% --chat %chat% --user %user% --token %token% diff --git a/docs/ru/cli/Bitrix24/ОтключитьУведомленияЧата.txt b/docs/ru/cli/Bitrix24/ОтключитьУведомленияЧата.txt new file mode 100644 index 0000000000..32304de0c5 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтключитьУведомленияЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ОтключитьУведомленияЧата --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ОтметитьСообщениеКакНепрочитанное.txt b/docs/ru/cli/Bitrix24/ОтметитьСообщениеКакНепрочитанное.txt new file mode 100644 index 0000000000..e72853c760 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтметитьСообщениеКакНепрочитанное.txt @@ -0,0 +1 @@ +oint bitrix24 ОтметитьСообщениеКакНепрочитанное --url %url% --chat %chat% --message %message% --token %token% diff --git a/docs/ru/cli/Bitrix24/ОтметитьСообщениеКакПрочитанное.txt b/docs/ru/cli/Bitrix24/ОтметитьСообщениеКакПрочитанное.txt new file mode 100644 index 0000000000..fb330c6d12 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтметитьСообщениеКакПрочитанное.txt @@ -0,0 +1 @@ +oint bitrix24 ОтметитьСообщениеКакПрочитанное --url %url% --chat %chat% --message %message% --token %token% diff --git a/docs/ru/cli/Bitrix24/ОтправитьСообщение.txt b/docs/ru/cli/Bitrix24/ОтправитьСообщение.txt new file mode 100644 index 0000000000..3c001e58dd --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтправитьСообщение.txt @@ -0,0 +1 @@ +oint bitrix24 ОтправитьСообщение --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% diff --git a/docs/ru/cli/Bitrix24/ОтправитьУведомлениеОВводе.txt b/docs/ru/cli/Bitrix24/ОтправитьУведомлениеОВводе.txt new file mode 100644 index 0000000000..77b4e0c398 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтправитьУведомлениеОВводе.txt @@ -0,0 +1 @@ +oint bitrix24 ОтправитьУведомлениеОВводе --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ОтправитьФайл.txt b/docs/ru/cli/Bitrix24/ОтправитьФайл.txt new file mode 100644 index 0000000000..6c4289564d --- /dev/null +++ b/docs/ru/cli/Bitrix24/ОтправитьФайл.txt @@ -0,0 +1 @@ +oint bitrix24 ОтправитьФайл --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПокинутьЧат.txt b/docs/ru/cli/Bitrix24/ПокинутьЧат.txt new file mode 100644 index 0000000000..e8363914a7 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПокинутьЧат.txt @@ -0,0 +1 @@ +oint bitrix24 ПокинутьЧат --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьБлокКартинки.txt b/docs/ru/cli/Bitrix24/ПолучитьБлокКартинки.txt new file mode 100644 index 0000000000..00d94346b5 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьБлокКартинки.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьБлокКартинки --title %title% --url %url% diff --git a/docs/ru/cli/Bitrix24/ПолучитьБлокФайла.txt b/docs/ru/cli/Bitrix24/ПолучитьБлокФайла.txt new file mode 100644 index 0000000000..64dca11356 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьБлокФайла.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьБлокФайла --title %title% --url %url% diff --git a/docs/ru/cli/Bitrix24/ПолучитьДиалог.txt b/docs/ru/cli/Bitrix24/ПолучитьДиалог.txt new file mode 100644 index 0000000000..443935b593 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьДиалог.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьДиалог --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьКаталогФайловЧата.txt b/docs/ru/cli/Bitrix24/ПолучитьКаталогФайловЧата.txt new file mode 100644 index 0000000000..f179373bc2 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьКаталогФайловЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьКаталогФайловЧата --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьПланЗадачНаДень.txt b/docs/ru/cli/Bitrix24/ПолучитьПланЗадачНаДень.txt new file mode 100644 index 0000000000..d76eeb8cbe --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьПланЗадачНаДень.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьПланЗадачНаДень --url %url% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСписокПользователейДиалога.txt b/docs/ru/cli/Bitrix24/ПолучитьСписокПользователейДиалога.txt new file mode 100644 index 0000000000..055b3826a5 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСписокПользователейДиалога.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСписокПользователейДиалога --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСписокПользователейЧата.txt b/docs/ru/cli/Bitrix24/ПолучитьСписокПользователейЧата.txt new file mode 100644 index 0000000000..1f0a49d3fc --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСписокПользователейЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСписокПользователейЧата --url %url% --chat %chat% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСписокСообщенийЧата.txt b/docs/ru/cli/Bitrix24/ПолучитьСписокСообщенийЧата.txt new file mode 100644 index 0000000000..38935e3632 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСписокСообщенийЧата.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСписокСообщенийЧата --url %url% --chat %chat% --last %last% --first %first% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСписокТрудозатратЗадачи.txt b/docs/ru/cli/Bitrix24/ПолучитьСписокТрудозатратЗадачи.txt new file mode 100644 index 0000000000..efe25df801 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьСписокТрудозатратЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьСписокТрудозатратЗадачи --url %url% --task %task% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьСтруктуруЧата.txt b/docs/ru/cli/Bitrix24/ПолучитьСтруктуруЧата.txt new file mode 100644 index 0000000000..de319a83b2 --- /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..ff8dbe8951 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьТрудозатратыЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьЧеклистЗадачи.txt b/docs/ru/cli/Bitrix24/ПолучитьЧеклистЗадачи.txt new file mode 100644 index 0000000000..2b00d16779 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьЧеклистЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьЧеклистЗадачи --url %url% --task %task% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПолучитьЭлементЧеклистаЗадачи.txt b/docs/ru/cli/Bitrix24/ПолучитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..a5031a52be --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПолучитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 ПолучитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% diff --git a/docs/ru/cli/Bitrix24/ПрочитатьВсе.txt b/docs/ru/cli/Bitrix24/ПрочитатьВсе.txt new file mode 100644 index 0000000000..d509a59ad5 --- /dev/null +++ b/docs/ru/cli/Bitrix24/ПрочитатьВсе.txt @@ -0,0 +1 @@ +oint bitrix24 ПрочитатьВсе --url %url% --token %token% diff --git a/docs/ru/cli/Bitrix24/СменитьВладельцаЧата.txt b/docs/ru/cli/Bitrix24/СменитьВладельцаЧата.txt new file mode 100644 index 0000000000..28664e3265 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СменитьВладельцаЧата.txt @@ -0,0 +1 @@ +oint bitrix24 СменитьВладельцаЧата --url %url% --chat %chat% --user %user% --token %token% diff --git a/docs/ru/cli/Bitrix24/СоздатьЧат.txt b/docs/ru/cli/Bitrix24/СоздатьЧат.txt new file mode 100644 index 0000000000..37cfdffd20 --- /dev/null +++ b/docs/ru/cli/Bitrix24/СоздатьЧат.txt @@ -0,0 +1 @@ +oint bitrix24 СоздатьЧат --url %url% --fields %fields% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьСообщение.txt b/docs/ru/cli/Bitrix24/УдалитьСообщение.txt new file mode 100644 index 0000000000..54f823ff78 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьСообщение.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьСообщение --url %url% --message %message% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьТрудозатратыЗадачи.txt b/docs/ru/cli/Bitrix24/УдалитьТрудозатратыЗадачи.txt new file mode 100644 index 0000000000..d27047904b --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьТрудозатратыЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% diff --git a/docs/ru/cli/Bitrix24/УдалитьЭлементЧеклистаЗадачи.txt b/docs/ru/cli/Bitrix24/УдалитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..56228b6455 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УдалитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1 @@ +oint bitrix24 УдалитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% diff --git a/docs/ru/cli/Bitrix24/УстановитьРеакциюНаСообщение.txt b/docs/ru/cli/Bitrix24/УстановитьРеакциюНаСообщение.txt new file mode 100644 index 0000000000..b87d1ed704 --- /dev/null +++ b/docs/ru/cli/Bitrix24/УстановитьРеакциюНаСообщение.txt @@ -0,0 +1 @@ +oint bitrix24 УстановитьРеакциюНаСообщение --url %url% --message %message% --token %token% diff --git a/docs/ru/examples/Bitrix24/ВключитьУведомленияЧата.txt b/docs/ru/examples/Bitrix24/ВключитьУведомленияЧата.txt new file mode 100644 index 0000000000..59ce42ee68 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ВключитьУведомленияЧата.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата, Токен); diff --git a/docs/ru/examples/Bitrix24/ВозобновитьЭлементЧеклистаЗадачи.txt b/docs/ru/examples/Bitrix24/ВозобновитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..fedc3dbd38 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ВозобновитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1,14 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = 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..17ddb94e1d --- /dev/null +++ b/docs/ru/examples/Bitrix24/ВыполнитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1,14 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = 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..b12b56d542 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьПользователейВЧат.txt @@ -0,0 +1,16 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + IDПользователей = Новый Массив; + IDПользователей.Добавить(10); + IDПользователей.Добавить(12); + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователей); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + IDПользователя = 10; + + Результат = 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..56112a2779 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьТрудозатратыЗадачи.txt @@ -0,0 +1,24 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + + Время = 3600; + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL, IDЗадачи, Время); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Текст = "Трудозатраты по обработке"; + IDПользователя = 10; + Время = 7200; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = 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..8b7590108c --- /dev/null +++ b/docs/ru/examples/Bitrix24/ДобавитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1,15 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + + Текст = "Пункт чек-листа"; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, Истина); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, , Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьЗаголовокЧата.txt b/docs/ru/examples/Bitrix24/ИзменитьЗаголовокЧата.txt new file mode 100644 index 0000000000..ce89f8fdc4 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьЗаголовокЧата.txt @@ -0,0 +1,15 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Заголовок = "Новый заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Заголовок = "Другой заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьКартинкуЧата.txt b/docs/ru/examples/Bitrix24/ИзменитьКартинкуЧата.txt new file mode 100644 index 0000000000..37b29e0087 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьКартинкуЧата.txt @@ -0,0 +1,13 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Картинка = ПараметрыФункции["Picture2"]; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьСообщение.txt b/docs/ru/examples/Bitrix24/ИзменитьСообщение.txt new file mode 100644 index 0000000000..d05666b008 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьСообщение.txt @@ -0,0 +1,20 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Текст = "Новый текст сообщения"; + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx", Файл)); + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст, Вложения, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьСтадиюКанбана.txt b/docs/ru/examples/Bitrix24/ИзменитьСтадиюКанбана.txt new file mode 100644 index 0000000000..3615352beb --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьСтадиюКанбана.txt @@ -0,0 +1,17 @@ + Наименование = "Новое имя стадии стадии"; + Цвет = "000000"; + IDСтадии = ПараметрыФункции["Bitrix24_HookStageID"]; + + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет); + + + Наименование = "Новое имя стадии стадии 2"; + Цвет = "000000"; + IDСтадии = ПараметрыФункции["Bitrix24_StageID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет, 6, Истина, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьТрудозатратыЗадачи.txt b/docs/ru/examples/Bitrix24/ИзменитьТрудозатратыЗадачи.txt new file mode 100644 index 0000000000..b4a1b30d71 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьТрудозатратыЗадачи.txt @@ -0,0 +1,25 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + IDЗаписи = ПараметрыФункции["Bitrix24_HookTimeID"]; + + Текст = "Забытый в прошлый раз текст"; + Время = 4800; + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Время, Текст); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗаписи = ПараметрыФункции["Bitrix24_TimeID"]; + + Текст = "Новые трудозатраты по обработке"; + Время = 4800; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = 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..16eefe138c --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьЦветЧата.txt @@ -0,0 +1,15 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Цвет = "AZURE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Цвет = "PURPLE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет, Токен); diff --git a/docs/ru/examples/Bitrix24/ИзменитьЭлементЧеклистаЗадачи.txt b/docs/ru/examples/Bitrix24/ИзменитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..5cf9770351 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИзменитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1,16 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Текст = "Новый текст пункта чек-листа"; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + Результат = 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..4148c734fc --- /dev/null +++ b/docs/ru/examples/Bitrix24/ИсключитьПользователяИзЧата.txt @@ -0,0 +1,13 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = 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..0fc949da16 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтключитьУведомленияЧата.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата, Токен); diff --git a/docs/ru/examples/Bitrix24/ОтметитьСообщениеКакНепрочитанное.txt b/docs/ru/examples/Bitrix24/ОтметитьСообщениеКакНепрочитанное.txt new file mode 100644 index 0000000000..b58339acd7 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтметитьСообщениеКакНепрочитанное.txt @@ -0,0 +1,13 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDЧата, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = 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..df3bb04100 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтметитьСообщениеКакПрочитанное.txt @@ -0,0 +1,13 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDЧата, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = 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..0eb3e9395e --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтправитьСообщение.txt @@ -0,0 +1,19 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx", Файл)); + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDЧата, Текст, Вложения); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDПользователя, Текст, , Токен); diff --git a/docs/ru/examples/Bitrix24/ОтправитьУведомлениеОВводе.txt b/docs/ru/examples/Bitrix24/ОтправитьУведомлениеОВводе.txt new file mode 100644 index 0000000000..c4eff62e34 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтправитьУведомлениеОВводе.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDПользователя, Токен); diff --git a/docs/ru/examples/Bitrix24/ОтправитьФайл.txt b/docs/ru/examples/Bitrix24/ОтправитьФайл.txt new file mode 100644 index 0000000000..bd0b56a7dc --- /dev/null +++ b/docs/ru/examples/Bitrix24/ОтправитьФайл.txt @@ -0,0 +1,25 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + Файл = ПараметрыФункции["Document"]; // Двоичные данные, URL или путь к файлу + Описание = "Очень важный файл"; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога, Токен); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = 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..32be34fdcd --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПокинутьЧат.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьДиалог.txt b/docs/ru/examples/Bitrix24/ПолучитьДиалог.txt new file mode 100644 index 0000000000..bd084b0082 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьДиалог.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDПользователя, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьКаталогФайловЧата.txt b/docs/ru/examples/Bitrix24/ПолучитьКаталогФайловЧата.txt new file mode 100644 index 0000000000..42d46236ac --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьКаталогФайловЧата.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьПланЗадачНаДень.txt b/docs/ru/examples/Bitrix24/ПолучитьПланЗадачНаДень.txt new file mode 100644 index 0000000000..0cce8a9104 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьПланЗадачНаДень.txt @@ -0,0 +1,9 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокПользователейДиалога.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокПользователейДиалога.txt new file mode 100644 index 0000000000..59fa685fd9 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокПользователейДиалога.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDПользователя, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокПользователейЧата.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокПользователейЧата.txt new file mode 100644 index 0000000000..66b8347a7c --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокПользователейЧата.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокСообщенийЧата.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокСообщенийЧата.txt new file mode 100644 index 0000000000..402101f25d --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокСообщенийЧата.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat4"; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0,Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьСписокТрудозатратЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьСписокТрудозатратЗадачи.txt new file mode 100644 index 0000000000..0b4a6cd603 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьСписокТрудозатратЗадачи.txt @@ -0,0 +1,10 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьТрудозатратыЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьТрудозатратыЗадачи.txt new file mode 100644 index 0000000000..bd81a76651 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьТрудозатратыЗадачи.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + IDЗаписи = ПараметрыФункции["Bitrix24_HookTimeID"]; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗаписи = ПараметрыФункции["Bitrix24_TimeID"]; + + Результат = 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..e051d8871c --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьЧеклистЗадачи.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи, Токен); diff --git a/docs/ru/examples/Bitrix24/ПолучитьЭлементЧеклистаЗадачи.txt b/docs/ru/examples/Bitrix24/ПолучитьЭлементЧеклистаЗадачи.txt new file mode 100644 index 0000000000..a88187d2c1 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПолучитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1,14 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = 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..ae9d9bb840 --- /dev/null +++ b/docs/ru/examples/Bitrix24/ПрочитатьВсе.txt @@ -0,0 +1,9 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL, Токен); diff --git a/docs/ru/examples/Bitrix24/СменитьВладельцаЧата.txt b/docs/ru/examples/Bitrix24/СменитьВладельцаЧата.txt new file mode 100644 index 0000000000..b36e2e024c --- /dev/null +++ b/docs/ru/examples/Bitrix24/СменитьВладельцаЧата.txt @@ -0,0 +1,13 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = 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..5e7e0edfea --- /dev/null +++ b/docs/ru/examples/Bitrix24/СоздатьЧат.txt @@ -0,0 +1,33 @@ + Картинка = ПараметрыФункции["Picture"]; + OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); + + B64Картинка = ПолучитьBase64СтрокуИзДвоичныхДанных(Картинка); + + МассивУчастников = Новый Массив; + МассивУчастников.Добавить(10); + МассивУчастников.Добавить(1); + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "OPEN"); + СтруктураЧата.Вставить("TITLE" , "Новый чат"); + СтруктураЧата.Вставить("DESCRIPTION", "Это новый чат"); + СтруктураЧата.Вставить("COLOR" , "GREEN"); + СтруктураЧата.Вставить("MESSAGE" , "Добро пожаловать в новый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + СтруктураЧата.Вставить("AVATAR" , B64Картинка); + СтруктураЧата.Вставить("OWNER_ID" , 1); + + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "CHAT"); + СтруктураЧата.Вставить("TITLE" , "Закрытый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата, Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьСообщение.txt b/docs/ru/examples/Bitrix24/УдалитьСообщение.txt new file mode 100644 index 0000000000..429137d953 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьСообщение.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения, Токен); diff --git a/docs/ru/examples/Bitrix24/УдалитьТрудозатратыЗадачи.txt b/docs/ru/examples/Bitrix24/УдалитьТрудозатратыЗадачи.txt new file mode 100644 index 0000000000..e239721104 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьТрудозатратыЗадачи.txt @@ -0,0 +1,12 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + IDЗаписи = ПараметрыФункции["Bitrix24_HookTimeID"]; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗаписи = ПараметрыФункции["Bitrix24_TimeID"]; + + Результат = 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..0396f2f85e --- /dev/null +++ b/docs/ru/examples/Bitrix24/УдалитьЭлементЧеклистаЗадачи.txt @@ -0,0 +1,14 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = 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..feb7b64f20 --- /dev/null +++ b/docs/ru/examples/Bitrix24/УстановитьРеакциюНаСообщение.txt @@ -0,0 +1,11 @@ + URL = ПараметрыФункции["Bitrix24_URL"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения, Токен); diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md similarity index 93% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md index 65a4172e1f..265184a593 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-subfolder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Create-subfolder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 2 --- # Создать подкаталог @@ -21,7 +21,10 @@ sidebar_position: 9
- +:::tip +Метод в документации API: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md similarity index 91% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md index 7630649682..2655391d4e 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Delete-folder.md @@ -1,62 +1,65 @@ ---- -sidebar_position: 13 ---- - -# Удалить каталог - Удаляет каталог с подкаталогами - - - -`Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDКаталога | --folderid | Строка, Число | Идентификатор удаляемого каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - IDКаталога = "480"; - - Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога); - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - IDКаталога = "482"; - - Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1719047257.50616, - "finish": 1719047257.55445, - "duration": 0.048285961151123, - "processing": 0.0174880027770996, - "date_start": "2024-06-22T09:07:37+00:00", - "date_finish": "2024-06-22T09:07:37+00:00", - "operating_reset_at": 1719047857, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Удалить каталог + Удаляет каталог с подкаталогами + + + +`Функция УдалитьКаталог(Знач URL, Знач IDКаталога, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDКаталога | --folderid | Строка, Число | Идентификатор удаляемого каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDКаталога = "480"; + + Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + IDКаталога = "482"; + + Результат = OPI_Bitrix24.УдалитьКаталог(URL, IDКаталога, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1719047257.50616, + "finish": 1719047257.55445, + "duration": 0.048285961151123, + "processing": 0.0174880027770996, + "date_start": "2024-06-22T09:07:37+00:00", + "date_finish": "2024-06-22T09:07:37+00:00", + "operating_reset_at": 1719047857, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md similarity index 91% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md index 01357da1cb..437dd8ce9d 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-external-link.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md @@ -1,5 +1,5 @@ --- -sidebar_position: 14 +sidebar_position: 6 --- # Получить внешнюю ссылку каталога @@ -20,7 +20,10 @@ sidebar_position: 14
- +:::tip +Метод в документации API: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md similarity index 91% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md index 2a53807803..03f74b60a2 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-filter-structure.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md @@ -1,5 +1,5 @@ --- -sidebar_position: 27 +sidebar_position: 11 --- # Получить структуру фильтра каталога @@ -20,7 +20,10 @@ sidebar_position: 27
- +:::tip +Метод в документации API: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md similarity index 93% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md index e7a1641235..616e5bd2fb 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-information.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-information.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 1 --- # Получить информацию о каталоге @@ -20,7 +20,10 @@ sidebar_position: 8
- +:::tip +Метод в документации API: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md index ec3fe825e9..5c0f231a1a 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-folder-items.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Get-folder-items.md @@ -1,5 +1,5 @@ --- -sidebar_position: 15 +sidebar_position: 7 --- # Получить дочерние элементы каталога @@ -21,7 +21,10 @@ sidebar_position: 15
- +:::tip +Метод в документации API: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md index 4d4120f42d..ddbb622a9a 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-folder-copy.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Make-folder-copy.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 3 --- # Скопировать каталог @@ -21,7 +21,10 @@ sidebar_position: 10
- +:::tip +Метод в документации API: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md similarity index 93% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md index 969e4bf9ab..c175ebf3ed 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-folder-as-deleted.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md @@ -1,5 +1,5 @@ --- -sidebar_position: 16 +sidebar_position: 8 --- # Поместить каталог в корзину @@ -20,7 +20,10 @@ sidebar_position: 16
- +:::tip +Метод в документации API: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Move-folder.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md index 89f7dd9d0e..0c6375ea14 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Move-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 11 +sidebar_position: 4 --- # Переместить каталог @@ -21,7 +21,10 @@ sidebar_position: 11
- +:::tip +Метод в документации API: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-folder.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md index 51efb8e939..ba4c7cf4a6 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Rename-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 18 +sidebar_position: 10 --- # Переименовать каталог @@ -21,7 +21,10 @@ sidebar_position: 18
- +:::tip +Метод в документации API: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-folder.md b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md similarity index 93% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-folder.md rename to docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md index f5d8fb4a9f..198dc8acea 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-folder.md +++ b/docs/ru/md/Bitrix24/Catalogs-managment/Restore-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 17 +sidebar_position: 9 --- # Восстановить каталог @@ -20,7 +20,10 @@ sidebar_position: 17
- +:::tip +Метод в документации API: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json b/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json new file mode 100644 index 0000000000..108d856a3e --- /dev/null +++ b/docs/ru/md/Bitrix24/Catalogs-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с каталогами", +"position": "10" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md new file mode 100644 index 0000000000..5baf211e94 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 4 +--- + +# Добавить пользователей в чат + Добавляет пользователей в чат по массиву ID + + + +`Функция ДобавитьПользователейВЧат(Знач URL, Знач IDЧата, Знач IDПользователей, Знач СкрытьИсторию = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователей | --users | Массив из Строка, Число | ID пользователей для добавления | + | СкрытьИсторию | --hide | Булево | Скрыть старые сообщения от новых пользователей | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + IDПользователей = Новый Массив; + IDПользователей.Добавить(10); + IDПользователей.Добавить(12); + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователей); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ДобавитьПользователейВЧат(URL, IDЧата, IDПользователя, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьПользователейВЧат --url %url% --chat %chat% --users %users% --hide %hide% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865686.43672, + "finish": 1720865686.52541, + "duration": 0.0886859893798828, + "processing": 0.0491659641265869, + "date_start": "2024-07-13T10:14:46+00:00", + "date_finish": "2024-07-13T10:14:46+00:00", + "operating_reset_at": 1720866286, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md new file mode 100644 index 0000000000..52974d8241 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md @@ -0,0 +1,74 @@ +--- +sidebar_position: 7 +--- + +# Изменить цвет чата + Изменяет цвет чата для мобильного приложения + + + +`Функция ИзменитьЦветЧата(Знач URL, Знач IDЧата, Знач Цвет, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Цвет | --color | Строка | Новый цвет чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) + + Доступные цвета: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, + + MARENGO, GRAY, GRAPHITE +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Цвет = "AZURE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Цвет = "PURPLE"; + + Результат = OPI_Bitrix24.ИзменитьЦветЧата(URL, IDЧата, Цвет, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьЦветЧата --url %url% --chat %chat% --color %color% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865688.95778, + "finish": 1720865689.02493, + "duration": 0.0671589374542236, + "processing": 0.0428512096405029, + "date_start": "2024-07-13T10:14:48+00:00", + "date_finish": "2024-07-13T10:14:49+00:00", + "operating_reset_at": 1720866288, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md new file mode 100644 index 0000000000..5af55f5ae7 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 9 +--- + +# Сменить владельца чата + Изменяет пользователя владельца чата + + + +`Функция СменитьВладельцаЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователя | --user | Строка, Число | ID пользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.СменитьВладельцаЧата(URL, IDЧата, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СменитьВладельцаЧата --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865697.10595, + "finish": 1720865697.13924, + "duration": 0.0332820415496826, + "processing": 0.0104668140411377, + "date_start": "2024-07-13T10:14:57+00:00", + "date_finish": "2024-07-13T10:14:57+00:00", + "operating_reset_at": 1720866297, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md new file mode 100644 index 0000000000..4fab762ed2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 8 +--- + +# Изменить картинку чата + Устанавливает новую картинку чата + + + +`Функция ИзменитьКартинкуЧата(Знач URL, Знач IDЧата, Знач Картинка, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Картинка | --picture | Строка, ДвоичныеДанные | Данные файла картинки | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Картинка = ПараметрыФункции["Picture2"]; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ИзменитьКартинкуЧата(URL, IDЧата, Картинка, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьКартинкуЧата --url %url% --chat %chat% --picture %picture% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865692.90718, + "finish": 1720865693.81896, + "duration": 0.91178297996521, + "processing": 0.884725093841553, + "date_start": "2024-07-13T10:14:52+00:00", + "date_finish": "2024-07-13T10:14:53+00:00", + "operating_reset_at": 1720866292, + "operating": 0.884703874588013 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md new file mode 100644 index 0000000000..9f78f4f2a9 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md @@ -0,0 +1,70 @@ +--- +sidebar_position: 6 +--- + +# Изменить заголовок чата + Изменяет текст заголовка чата + + + +`Функция ИзменитьЗаголовокЧата(Знач URL, Знач IDЧата, Знач Заголовок, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Заголовок | --title | Строка | Новый текст заголовка | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Заголовок = "Новый заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Заголовок = "Другой заголовок чата"; + + Результат = OPI_Bitrix24.ИзменитьЗаголовокЧата(URL, IDЧата, Заголовок, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьЗаголовокЧата --url %url% --chat %chat% --title %title% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865687.70928, + "finish": 1720865687.78107, + "duration": 0.0717928409576416, + "processing": 0.0479631423950195, + "date_start": "2024-07-13T10:14:47+00:00", + "date_finish": "2024-07-13T10:14:47+00:00", + "operating_reset_at": 1720866287, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md new file mode 100644 index 0000000000..17e6f81648 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 1 +--- + +# Создать чат + Создает новый чат на основе структуры полей + + + +`Функция СоздатьЧат(Знач URL, Знач СтруктураЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | СтруктураЧата | --fields | Структура Из КлючИЗначение | Структура полей чата. См. ПолучитьСтруктуруЧата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093) +::: +
+ + +```bsl title="Пример кода" + Картинка = ПараметрыФункции["Picture"]; + OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); + + B64Картинка = ПолучитьBase64СтрокуИзДвоичныхДанных(Картинка); + + МассивУчастников = Новый Массив; + МассивУчастников.Добавить(10); + МассивУчастников.Добавить(1); + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "OPEN"); + СтруктураЧата.Вставить("TITLE" , "Новый чат"); + СтруктураЧата.Вставить("DESCRIPTION", "Это новый чат"); + СтруктураЧата.Вставить("COLOR" , "GREEN"); + СтруктураЧата.Вставить("MESSAGE" , "Добро пожаловать в новый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + СтруктураЧата.Вставить("AVATAR" , B64Картинка); + СтруктураЧата.Вставить("OWNER_ID" , 1); + + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + СтруктураЧата = Новый Структура; + СтруктураЧата.Вставить("TYPE" , "CHAT"); + СтруктураЧата.Вставить("TITLE" , "Закрытый чат"); + СтруктураЧата.Вставить("USERS" , МассивУчастников); + + Результат = OPI_Bitrix24.СоздатьЧат(URL, СтруктураЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьЧат --url %url% --fields %fields% --token %token% + +``` + +```json title="Результат" +{ + "result": 26, + "time": { + "start": 1720816597.42171, + "finish": 1720816597.52933, + "duration": 0.107618093490601, + "processing": 0.081672191619873, + "date_start": "2024-07-12T20:36:37+00:00", + "date_finish": "2024-07-12T20:36:37+00:00", + "operating_reset_at": 1720817197, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md new file mode 100644 index 0000000000..af45e2152c --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 5 +--- + +# Исключить пользователя из чата + Исключает выбранного пользователя из чата + + + +`Функция ИсключитьПользователяИзЧата(Знач URL, Знач IDЧата, Знач IDПользователя, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDПользователя | --user | Строка, Число | ID пользователя | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + IDПользователя = 10; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ИсключитьПользователяИзЧата(URL, IDЧата, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИсключитьПользователяИзЧата --url %url% --chat %chat% --user %user% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865685.25089, + "finish": 1720865685.32425, + "duration": 0.0733590126037598, + "processing": 0.0480890274047852, + "date_start": "2024-07-13T10:14:45+00:00", + "date_finish": "2024-07-13T10:14:45+00:00", + "operating_reset_at": 1720866285, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md new file mode 100644 index 0000000000..89d7510af3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 10 +--- + +# Отключить уведомления чата + Отключает уведомлений чата + + + +`Функция ОтключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ОтключитьУведомленияЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтключитьУведомленияЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865694.86568, + "finish": 1720865694.9092, + "duration": 0.0435128211975098, + "processing": 0.0169928073883057, + "date_start": "2024-07-13T10:14:54+00:00", + "date_finish": "2024-07-13T10:14:54+00:00", + "operating_reset_at": 1720866294, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md new file mode 100644 index 0000000000..1a2f369ecc --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 11 +--- + +# Включить уведомления чата + Включает уведомления в чате + + + +`Функция ВключитьУведомленияЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ВключитьУведомленияЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВключитьУведомленияЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720865695.99933, + "finish": 1720865696.04205, + "duration": 0.0427119731903076, + "processing": 0.0170090198516846, + "date_start": "2024-07-13T10:14:55+00:00", + "date_finish": "2024-07-13T10:14:56+00:00", + "operating_reset_at": 1720866296, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md new file mode 100644 index 0000000000..081b33f8bb --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 17 +--- + +# Получить каталог файлов чата + Получает каталог для хранения фйлов чата + + + +`Функция ПолучитьКаталогФайловЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьКаталогФайловЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": 3250 + }, + "time": { + "start": 1720969169.10256, + "finish": 1720969169.1584, + "duration": 0.0558350086212158, + "processing": 0.0327038764953613, + "date_start": "2024-07-14T14:59:29+00:00", + "date_finish": "2024-07-14T14:59:29+00:00", + "operating_reset_at": 1720969769, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md new file mode 100644 index 0000000000..d9d32fb838 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md @@ -0,0 +1,121 @@ +--- +sidebar_position: 14 +--- + +# Получить список пользователей диалога + Получает список участников далога + + + +`Функция ПолучитьСписокПользователейДиалога(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейДиалога(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокПользователейДиалога --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + }, + { + "id": 1, + "active": true, + "name": "Антон Титовец", + "first_name": "Антон", + "last_name": "Титовец", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "bot_data": null + } + ], + "total": 2, + "time": { + "start": 1720969161.4388, + "finish": 1720969161.46946, + "duration": 0.0306570529937744, + "processing": 0.00571608543395996, + "date_start": "2024-07-14T14:59:21+00:00", + "date_finish": "2024-07-14T14:59:21+00:00", + "operating_reset_at": 1720969761, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md new file mode 100644 index 0000000000..ae62af294f --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md @@ -0,0 +1,401 @@ +--- +sidebar_position: 12 +--- + +# Получить список сообщений чата + Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего + + + +`Функция ПолучитьСписокСообщенийЧата(Знач URL, Знач IDЧата, Знач IDПоследнего = "", Знач IDПервого = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDПоследнего | --last | Строка, Число | ID последнего загруженного сообщения | + | IDПервого | --first | Строка, Число | ID первого загруженного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat4"; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0,Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокСообщенийЧата --url %url% --chat %chat% --last %last% --first %first% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "chat_id": 10, + "messages": [ + { + "id": 3854, + "chat_id": 10, + "author_id": 10, + "date": "2024-07-13T14:54:43+00:00", + "text": "Записал", + "unread": false, + "uuid": "700d361d-8324-47fb-b989-647949c1c899", + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4286, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:06:51+00:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4366, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T16:40:58+00:00", + "text": "Message text", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4406, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T19:57:33+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4446, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:21:27+00:00", + "text": "Текст сообщения", + "unread": false, + "uuid": null, + "replaces": [], + "params": [], + "disappearing_date": null + }, + { + "id": 4486, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:22:30+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4526, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-13T20:41:21+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4668, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:10:33+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4708, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:22:56+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4748, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:26:01+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4788, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:01+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4828, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:28:36+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4868, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:30:18+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4908, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:52:24+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4948, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:53:31+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 4990, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:57:06+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5060, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T08:59:43+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5140, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:29:40+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5182, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T09:35:56+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + }, + { + "id": 5262, + "chat_id": 10, + "author_id": 1, + "date": "2024-07-14T11:27:54+00:00", + "text": "Это сообщение было удалено", + "unread": false, + "uuid": null, + "replaces": [], + "params": { + "IS_DELETED": "Y" + }, + "disappearing_date": null + } + ], + "users": [ + { + "id": 10, + "active": true, + "name": "Techno Pizza", + "first_name": "Techno", + "last_name": "Pizza", + "work_position": null, + "color": "#ab7761", + "avatar": "", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-13T18:36:23+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + }, + { + "id": 1, + "active": true, + "name": "Антон Титовец", + "first_name": "Антон", + "last_name": "Титовец", + "work_position": null, + "color": "#df532d", + "avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg", + "gender": "M", + "birthday": "", + "extranet": false, + "network": false, + "bot": false, + "connector": false, + "external_auth_id": "socservices", + "status": "online", + "idle": false, + "last_activity_date": "2024-07-14T09:00:58+00:00", + "mobile_last_date": false, + "absent": false, + "departments": [ + 1 + ], + "phones": false, + "desktop_last_date": false + } + ], + "files": [] + }, + "time": { + "start": 1720969156.38474, + "finish": 1720969156.42064, + "duration": 0.0358970165252686, + "processing": 0.0108029842376709, + "date_start": "2024-07-14T14:59:16+00:00", + "date_finish": "2024-07-14T14:59:16+00:00", + "operating_reset_at": 1720969756, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md new file mode 100644 index 0000000000..9114e8217f --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 18 +--- + +# Получить структуру чата + Получает структуру полей чата + + + +`Функция ПолучитьСтруктуруЧата(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания типов полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура полей + +
+ + + + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСтруктуруЧата --empty %empty% + +``` + + diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md new file mode 100644 index 0000000000..e134de2998 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 2 +--- + +# Получить список пользователей чата + Получает список пользователей чата по ID + + + +`Функция ПолучитьСписокПользователейЧата(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокПользователейЧата(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокПользователейЧата --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + 1, + 10 + ], + "time": { + "start": 1720816598.61771, + "finish": 1720816598.64882, + "duration": 0.0311079025268555, + "processing": 0.00316882133483887, + "date_start": "2024-07-12T20:36:38+00:00", + "date_finish": "2024-07-12T20:36:38+00:00", + "operating_reset_at": 1720817198, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md new file mode 100644 index 0000000000..8fc5472742 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md @@ -0,0 +1,134 @@ +--- +sidebar_position: 13 +--- + +# Получить диалог + Получает информацию о диалоге по ID + + + +`Функция ПолучитьДиалог(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ПолучитьДиалог(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьДиалог --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "id": 10, + "parent_chat_id": 0, + "parent_message_id": 0, + "name": "", + "description": "", + "owner": 10, + "extranet": false, + "avatar": "", + "color": "#ab7761", + "type": "private", + "counter": 1, + "user_counter": 0, + "message_count": 24, + "unread_id": 3854, + "restrictions": { + "avatar": true, + "rename": true, + "extend": true, + "call": true, + "mute": true, + "leave": true, + "leave_owner": true, + "send": true, + "user_list": true + }, + "last_message_id": 5262, + "last_id": 3852, + "marked_id": 0, + "disk_folder_id": 0, + "entity_type": "", + "entity_id": "", + "entity_data_1": "", + "entity_data_2": "", + "entity_data_3": "", + "mute_list": [], + "date_create": "2024-06-15T16:48:49+00:00", + "message_type": "P", + "disappearing_time": 0, + "public": "", + "role": "member", + "entity_link": { + "type": "", + "url": "" + }, + "permissions": { + "manage_users_add": "member", + "manage_users_delete": "manager", + "manage_ui": "member", + "manage_settings": "owner", + "manage_messages": "member", + "can_post": "member" + }, + "is_new": false, + "readed_list": [ + { + "user_id": 10, + "user_name": "Techno Pizza", + "message_id": 3854, + "date": null + } + ], + "manager_list": [], + "last_message_views": { + "message_id": 5262, + "first_viewers": [], + "count_of_viewers": 0 + }, + "dialog_id": "10" + }, + "time": { + "start": 1720969160.19046, + "finish": 1720969160.22782, + "duration": 0.037362813949585, + "processing": 0.0134620666503906, + "date_start": "2024-07-14T14:59:20+00:00", + "date_finish": "2024-07-14T14:59:20+00:00", + "operating_reset_at": 1720969760, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md new file mode 100644 index 0000000000..2f2bfcfb73 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 3 +--- + +# Покинуть чат + Исключает текущего пользователя из чата + + + +`Функция ПокинутьЧат(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Результат = OPI_Bitrix24.ПокинутьЧат(URL, IDЧата, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПокинутьЧат --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816599.74716, + "finish": 1720816599.81746, + "duration": 0.0702948570251465, + "processing": 0.0438079833984375, + "date_start": "2024-07-12T20:36:39+00:00", + "date_finish": "2024-07-12T20:36:39+00:00", + "operating_reset_at": 1720817199, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md new file mode 100644 index 0000000000..8d49d68b78 --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 16 +--- + +# Прочитать все + Отмечает все сообщения во всех доступных чатах как прочитанные + + + +`Функция ПрочитатьВсе(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПрочитатьВсе(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПрочитатьВсе --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969176.30834, + "finish": 1720969176.34001, + "duration": 0.0316698551177978, + "processing": 0.00501918792724609, + "date_start": "2024-07-14T14:59:36+00:00", + "date_finish": "2024-07-14T14:59:36+00:00", + "operating_reset_at": 1720969776, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md new file mode 100644 index 0000000000..dfac3b5f5a --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 15 +--- + +# Отправить уведомление о вводе + Отправляет в чат статус "Вам пишут..." + + + +`Функция ОтправитьУведомлениеОВводе(Знач URL, Знач IDЧата, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDЧата); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьУведомлениеОВводе(URL, IDПользователя, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтправитьУведомлениеОВводе --url %url% --chat %chat% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969162.6704, + "finish": 1720969162.69719, + "duration": 0.0267889499664307, + "processing": 0.000684022903442383, + "date_start": "2024-07-14T14:59:22+00:00", + "date_finish": "2024-07-14T14:59:22+00:00", + "operating_reset_at": 1720969762, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json new file mode 100644 index 0000000000..3e039d836d --- /dev/null +++ b/docs/ru/md/Bitrix24/Chats-and-dialogs-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с чатами и диалогами", +"position": "12" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md index 4353583ea7..6dc2d56687 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md @@ -21,7 +21,10 @@ sidebar_position: 3
- +:::tip +Метод в документации API: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md index f67ead6251..68d143933b 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md @@ -20,7 +20,10 @@ sidebar_position: 7
- +:::tip +Метод в документации API: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md index 8099681918..29d65ca46b 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md @@ -20,7 +20,10 @@ sidebar_position: 8
- +:::tip +Метод в документации API: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md index 4a03c20908..72aa5f24a7 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md @@ -21,7 +21,10 @@ sidebar_position: 5
- +:::tip +Метод в документации API: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md index 18aff80671..49f63ab368 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-results-list.md @@ -20,7 +20,10 @@ sidebar_position: 6
- +:::tip +Метод в документации API: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md index f29aa37e47..ed49545aac 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md @@ -21,7 +21,10 @@ sidebar_position: 2
- +:::tip +Метод в документации API: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md index 88e3e1c5d7..7b7d29e7a9 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md @@ -20,7 +20,10 @@ sidebar_position: 1
- +:::tip +Метод в документации API: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md index 718efc130f..60a05ab08d 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md @@ -22,7 +22,10 @@ sidebar_position: 4
- +:::tip +Метод в документации API: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json b/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json index c3ff2dfc4e..54bda699af 100644 --- a/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json +++ b/docs/ru/md/Bitrix24/Comments-and-results-managment/_category_.json @@ -1,4 +1,4 @@ { "label": "Работа с комментариями и результатами задач", -"position": "5" +"position": "6" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Feed-posts-managment/Crate-comment.md b/docs/ru/md/Bitrix24/Feed-posts-managment/Crate-comment.md deleted file mode 100644 index e53fe38523..0000000000 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Crate-comment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Добавить комментарий - Добавляет комментарий к новости - - -*Функция ДобавитьКомментарий(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDНовости | --postid | Строка, Число | ID новости | - | Текст | --text | Строка | Текст комментария | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -```bsl title="Пример кода" - - Текст = "Комментарий к новости"; - IDНовости = "124"; - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - - Результат = OPI_Bitrix24.ДобавитьКомментарий(URL, IDНовости, Текст); - - - Текст = "Другой комментарий к новости"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ДобавитьКомментарий(URL, IDНовости, Текст, Токен); - -``` - -```sh title="Пример команды CLI" - - oint bitrix24 ДобавитьКомментарий --url "b24-ar17wx.bitrix24.by" --postid "124" --text %text% --token "b9df7366006e9f06006b12e400000001000..." - -``` - - -```json title="Результат" - -{ - "result": 24, - "time": { - "start": 1718473316.57246, - "finish": 1718473316.67595, - "duration": 0.103492975234985, - "processing": 0.0729200839996338, - "date_start": "2024-06-15T17:41:56+00:00", - "date_finish": "2024-06-15T17:41:56+00:00", - "operating_reset_at": 1718473916, - "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 3af3081ac5..e7e298bf2f 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Create-post.md @@ -14,7 +14,7 @@ sidebar_position: 1 | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | | Текст | --text | Строка | Текст новости | | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | - | Файлы | --files | Строка | Данные вложений, где ключ > имя файла, значение > путь к файлу иди двоичные данные | + | Файлы | --files | Соответствие Из КлючИЗначение | Ключ > имя файла, значение > путь или двоичные данные | | Заголовок | --title | Строка | Заголовок новости | | Важное | --important | Булево | Помечает новость как важную | | Токен | --token | Строка | Токен авторизации, если используется не вебхук | 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 33685bf878..4e2b0d05b1 100644 --- a/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md +++ b/docs/ru/md/Bitrix24/Feed-posts-managment/Update-post.md @@ -15,7 +15,7 @@ sidebar_position: 2 | IDНовости | --postid | Строка, Число | ID новости | | Текст | --text | Строка | Текст новости | | Видимость | --vision | Строка | Массив или 1 получатель: UA все, SGn р. группа, Un пользователь, DRn отдел, Gn группа | - | Файлы | --files | Строка | Данные вложений, где ключ > имя файла, значение > путь к файлу иди двоичные данные | + | Файлы | --files | Соответствие Из КлючИЗначение | Ключ > имя файла, значение > путь или двоичные данные | | Заголовок | --title | Строка | Заголовок новости | | Токен | --token | Строка | Токен авторизации, если используется не вебхук | diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-file.md b/docs/ru/md/Bitrix24/File-managment/Delete-file.md similarity index 91% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-file.md rename to docs/ru/md/Bitrix24/File-managment/Delete-file.md index a9a274af78..89d006e6f9 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Delete-file.md +++ b/docs/ru/md/Bitrix24/File-managment/Delete-file.md @@ -1,62 +1,65 @@ ---- -sidebar_position: 12 ---- - -# Удалить файл - Удаляет файл по 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Файла = "488"; - - Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла); - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - IDФайла = "478"; - - Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 УдалитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": true, - "time": { - "start": 1718783933.86753, - "finish": 1718783937.64223, - "duration": 3.77469992637634, - "processing": 3.73617887496948, - "date_start": "2024-06-19T07:58:53+00:00", - "date_finish": "2024-06-19T07:58:57+00:00", - "operating_reset_at": 1718784533, - "operating": 3.73615193367004 - } -} -``` +--- +sidebar_position: 4 +--- + +# Удалить файл + Удаляет файл по ID + + + +`Функция УдалитьФайл(Знач URL, Знач IDФайла, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDФайла | --fileid | Строка, Число | Идентификатор удаляемого файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDФайла = "488"; + + Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + IDФайла = "478"; + + Результат = OPI_Bitrix24.УдалитьФайл(URL, IDФайла, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1718783933.86753, + "finish": 1718783937.64223, + "duration": 3.77469992637634, + "processing": 3.73617887496948, + "date_start": "2024-06-19T07:58:53+00:00", + "date_finish": "2024-06-19T07:58:57+00:00", + "operating_reset_at": 1718784533, + "operating": 3.73615193367004 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md similarity index 91% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md rename to docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md index 6578182b55..e2de9187d7 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-external-link.md +++ b/docs/ru/md/Bitrix24/File-managment/Get-file-external-link.md @@ -1,5 +1,5 @@ --- -sidebar_position: 21 +sidebar_position: 5 --- # Получить внешнюю ссылку файла @@ -20,7 +20,10 @@ sidebar_position: 21
- +:::tip +Метод в документации API: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-information.md b/docs/ru/md/Bitrix24/File-managment/Get-file-information.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-information.md rename to docs/ru/md/Bitrix24/File-managment/Get-file-information.md index 0355dc9b94..2c138e53fe 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-file-information.md +++ b/docs/ru/md/Bitrix24/File-managment/Get-file-information.md @@ -1,5 +1,5 @@ --- -sidebar_position: 20 +sidebar_position: 3 --- # Получить информацию о файле @@ -20,7 +20,10 @@ sidebar_position: 20
- +:::tip +Метод в документации API: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md similarity index 95% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md rename to docs/ru/md/Bitrix24/File-managment/Make-file-copy.md index 8ce5a95d05..3621e0373b 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Make-file-copy.md +++ b/docs/ru/md/Bitrix24/File-managment/Make-file-copy.md @@ -1,5 +1,5 @@ --- -sidebar_position: 24 +sidebar_position: 8 --- # Скопировать файл @@ -21,7 +21,10 @@ sidebar_position: 24
- +:::tip +Метод в документации API: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md rename to docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md index 85169d5b7d..d5c9a5215c 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Mark-file-as-deleted.md +++ b/docs/ru/md/Bitrix24/File-managment/Mark-file-as-deleted.md @@ -1,5 +1,5 @@ --- -sidebar_position: 22 +sidebar_position: 6 --- # Поместить файл в корзину @@ -20,7 +20,10 @@ sidebar_position: 22
- +:::tip +Метод в документации API: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md similarity index 95% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md rename to docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md index 243f162837..a4a6629ec5 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Move-file-to-folder.md +++ b/docs/ru/md/Bitrix24/File-managment/Move-file-to-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 25 +sidebar_position: 9 --- # Переместить файл @@ -21,7 +21,10 @@ sidebar_position: 25
- +:::tip +Метод в документации API: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-file.md b/docs/ru/md/Bitrix24/File-managment/Rename-file.md similarity index 95% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-file.md rename to docs/ru/md/Bitrix24/File-managment/Rename-file.md index edd4e82580..b7ff13d03b 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-file.md +++ b/docs/ru/md/Bitrix24/File-managment/Rename-file.md @@ -1,5 +1,5 @@ --- -sidebar_position: 26 +sidebar_position: 10 --- # Переименовать файл @@ -21,7 +21,10 @@ sidebar_position: 26
- +:::tip +Метод в документации API: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md b/docs/ru/md/Bitrix24/File-managment/Restore-file.md similarity index 94% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md rename to docs/ru/md/Bitrix24/File-managment/Restore-file.md index 02f1598ca0..213e5ad7f6 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Restore-file.md +++ b/docs/ru/md/Bitrix24/File-managment/Restore-file.md @@ -1,5 +1,5 @@ --- -sidebar_position: 23 +sidebar_position: 7 --- # Восстановить файл @@ -20,7 +20,10 @@ sidebar_position: 23
- +:::tip +Метод в документации API: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md similarity index 95% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md rename to docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md index 55b3d50aeb..e9249f2e8f 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-folder.md +++ b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-folder.md @@ -1,5 +1,5 @@ --- -sidebar_position: 19 +sidebar_position: 2 --- # Загрузить файл в каталог @@ -22,7 +22,10 @@ sidebar_position: 19
- +:::tip +Метод в документации API: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md similarity index 95% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md rename to docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md index ee3a01c885..d0bfba1bf6 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Upload-file-to-storage.md +++ b/docs/ru/md/Bitrix24/File-managment/Upload-file-to-storage.md @@ -1,91 +1,94 @@ ---- -sidebar_position: 6 ---- - -# Загрузить файл в хранилище - Загружает файл в выбранное хранилище - - - -`Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Наименование | --title | Строка | Наименование файла с расширением для сохранения | - | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | - | IDХранилища | --storageid | Строка | Идентификатор хранилища для загрузки | - | Доступы | --rights | Строка | Массив доступов по задачам, если необходимо | - | Токен | --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Приемника = 3; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование2, Картинка2, IDПриемника); - - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ЗагрузитьФайлВХранилище --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 356, - "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "GLOBAL_CONTENT_VERSION": 1, - "FILE_ID": 404, - "SIZE": "26", - "CREATE_TIME": "2024-06-19T07:58:50+00:00", - "UPDATE_TIME": "2024-06-19T07:58:50+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" - }, - "time": { - "start": 1718783929.8197, - "finish": 1718783930.09911, - "duration": 0.279407024383545, - "processing": 0.227760076522827, - "date_start": "2024-06-19T07:58:49+00:00", - "date_finish": "2024-06-19T07:58:50+00:00", - "operating_reset_at": 1718784529, - "operating": 0.227726936340332 - } -} -``` +--- +sidebar_position: 1 +--- + +# Загрузить файл в хранилище + Загружает файл в выбранное хранилище + + + +`Функция ЗагрузитьФайлВХранилище(Знач URL, Знач Наименование, Знач Файл, Знач IDХранилища, Знач Доступы = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Наименование файла с расширением для сохранения | + | Файл | --file | Строка, ДвоичныеДанные | Файл для загрузки | + | IDХранилища | --storageid | Строка | Идентификатор хранилища для загрузки | + | Доступы | --rights | Строка | Массив доступов по задачам, если необходимо | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php) +::: +
+ + +```bsl title="Пример кода" + Наименование2 = "Картинка2.jpg"; + Наименование = "Картинка1.jpg"; + + Картинка2 = "https://openintegrations.dev/test_data/picture.jpg"; // Локальный путь, URL или Двоичные данные + Картинка = "https://openintegrations.dev/test_data/picture2.jpg"; // Локальный путь, URL или Двоичные данные + + IDПриемника = 3; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование2, Картинка2, IDПриемника); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ЗагрузитьФайлВХранилище(URL, Наименование, Картинка, IDПриемника, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ЗагрузитьФайлВХранилище --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 356, + "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "GLOBAL_CONTENT_VERSION": 1, + "FILE_ID": 404, + "SIZE": "26", + "CREATE_TIME": "2024-06-19T07:58:50+00:00", + "UPDATE_TIME": "2024-06-19T07:58:50+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg" + }, + "time": { + "start": 1718783929.8197, + "finish": 1718783930.09911, + "duration": 0.279407024383545, + "processing": 0.227760076522827, + "date_start": "2024-06-19T07:58:49+00:00", + "date_finish": "2024-06-19T07:58:50+00:00", + "operating_reset_at": 1718784529, + "operating": 0.227726936340332 + } +} +``` diff --git a/docs/ru/md/Bitrix24/File-managment/_category_.json b/docs/ru/md/Bitrix24/File-managment/_category_.json new file mode 100644 index 0000000000..b24aa138bd --- /dev/null +++ b/docs/ru/md/Bitrix24/File-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с файлами", +"position": "11" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md index 0631ed4a06..dde7d0a301 100644 --- a/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Add-kanban-stage.md @@ -24,7 +24,10 @@ sidebar_position: 1
- +:::tip +Метод в документации API: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md index 73d2c3ae9a..281a453531 100644 --- a/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Delete-kanban-stage.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- # Удалить стадию канбана @@ -21,7 +21,10 @@ sidebar_position: 2
- +:::tip +Метод в документации API: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md index 786049d2f1..46ab36c1b0 100644 --- a/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md +++ b/docs/ru/md/Bitrix24/Kanban/Get-kanban-stages.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # Получить стадии канбана @@ -21,7 +21,10 @@ sidebar_position: 3
- +:::tip +Метод в документации API: [task.stages.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_get.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md index 283d86a3d1..1905db84ed 100644 --- a/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md +++ b/docs/ru/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Перенести задачу в стадию канбана @@ -23,7 +23,10 @@ sidebar_position: 4
- +:::tip +Метод в документации API: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md new file mode 100644 index 0000000000..16f0bcec7c --- /dev/null +++ b/docs/ru/md/Bitrix24/Kanban/Update-kanbans-stage.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 2 +--- + +# Изменить стадию канбана + Изменяет свойства существующей стадии канбана или Моего плана + + + +`Функция ИзменитьСтадиюКанбана(Знач URL, Знач Наименование, Знач IDСтадии, Знач Цвет = "", Знач IDПредыдущей = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Наименование | --title | Строка | Новое наименование стадии | + | IDСтадии | --stage | Строка, Число | ID стадии для изменения | + | Цвет | --color | Строка | HEX нового цвета стадии | + | IDПредыдущей | --prevstage | Строка, Число | ID стадии, после которой необходимо вставить выбранную | + | КакАдминистратор | --admin | Булево | Позволяет добавлять стадии без проверки прав (для администраторов) | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя стадии стадии"; + Цвет = "000000"; + IDСтадии = ПараметрыФункции["Bitrix24_HookStageID"]; + + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет); + + + Наименование = "Новое имя стадии стадии 2"; + Цвет = "000000"; + IDСтадии = ПараметрыФункции["Bitrix24_StageID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ИзменитьСтадиюКанбана(URL, Наименование, IDСтадии, Цвет, 6, Истина, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьСтадиюКанбана --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816577.57757, + "finish": 1720816577.66624, + "duration": 0.0886678695678711, + "processing": 0.059006929397583, + "date_start": "2024-07-12T20:36:17+00:00", + "date_finish": "2024-07-12T20:36:17+00:00", + "operating_reset_at": 1720817177, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Kanban/_category_.json b/docs/ru/md/Bitrix24/Kanban/_category_.json index 1ce3d1eb5c..c198abbabc 100644 --- a/docs/ru/md/Bitrix24/Kanban/_category_.json +++ b/docs/ru/md/Bitrix24/Kanban/_category_.json @@ -1,4 +1,4 @@ { "label": "Канбан", -"position": "6" +"position": "7" } \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Message-management/Delete-message.md b/docs/ru/md/Bitrix24/Message-management/Delete-message.md new file mode 100644 index 0000000000..47aa353697 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Delete-message.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 4 +--- + +# Удалить сообщение + Удаляет сообщение в диалоге + + + +`Функция УдалитьСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = OPI_Bitrix24.УдалитьСообщение(URL, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьСообщение --url %url% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969167.77137, + "finish": 1720969167.82331, + "duration": 0.051936149597168, + "processing": 0.0215229988098145, + "date_start": "2024-07-14T14:59:27+00:00", + "date_finish": "2024-07-14T14:59:27+00:00", + "operating_reset_at": 1720969767, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Edit-message.md b/docs/ru/md/Bitrix24/Message-management/Edit-message.md new file mode 100644 index 0000000000..902cd83ad7 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Edit-message.md @@ -0,0 +1,76 @@ +--- +sidebar_position: 2 +--- + +# Изменить сообщение + Изменяет сообщение в диалоге + + + +`Функция ИзменитьСообщение(Знач URL, Знач IDСообщения, Знач Текст = "", Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения для изменения | + | Текст | --text | Строка | Новый текст сообщения | + | Вложения | --blocks | Массив из Структура | Новый массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Текст = "Новый текст сообщения"; + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx", Файл)); + + Результат = OPI_Bitrix24.ИзменитьСообщение(URL, IDСообщения, Текст, Вложения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьСообщение --url %url% --message %message% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969165.17314, + "finish": 1720969165.21621, + "duration": 0.0430619716644287, + "processing": 0.018265962600708, + "date_start": "2024-07-14T14:59:25+00:00", + "date_finish": "2024-07-14T14:59:25+00:00", + "operating_reset_at": 1720969765, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Get-file-block.md b/docs/ru/md/Bitrix24/Message-management/Get-file-block.md new file mode 100644 index 0000000000..ba67a794ba --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Get-file-block.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 9 +--- + +# Получить блок файла + Формирует блок файла для отправки в функции ОтправитьСообщение + + + +`Функция ПолучитьБлокФайла(Знач Наименование, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование картинки | + | URL | --url | Строка | URL файла для отправки | + + + Возвращаемое значение: Структура - Блок с файлом + +
+ +:::tip +Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьБлокФайла --title %title% --url %url% + +``` + + diff --git a/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md new file mode 100644 index 0000000000..8a17edd29a --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Get-picture-block.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 8 +--- + +# Получить блок картинки + Формирует картинку для отправки в функции ОтправитьСообщение + + + +`Функция ПолучитьБлокКартинки(Знач Наименование, Знач URL) Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | Наименование | --title | Строка | Наименование картинки | + | URL | --url | Строка | URL картинки для отправки | + + + Возвращаемое значение: Структура - Блок с картинкой + +
+ +:::tip +Блоки в документации API: [Ссылка](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867) +::: +
+ + + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьБлокКартинки --title %title% --url %url% + +``` + + diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md new file mode 100644 index 0000000000..0f6ad22225 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-readed.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 6 +--- + +# Отметить сообщение как прочитанное + Отмечает выбранное сообщение и все сообщения до него как прочитанные + + + +`Функция ОтметитьСообщениеКакПрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDСообщения | --message | Строка, Число | ID последнего прочитанного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDЧата, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакПрочитанное(URL, IDПользователя, IDСообщения,Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтметитьСообщениеКакПрочитанное --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "dialogId": 10, + "chatId": 10, + "lastId": 5262, + "counter": 0 + }, + "time": { + "start": 1720969157.61149, + "finish": 1720969157.65659, + "duration": 0.0451040267944336, + "processing": 0.0171201229095459, + "date_start": "2024-07-14T14:59:17+00:00", + "date_finish": "2024-07-14T14:59:17+00:00", + "operating_reset_at": 1720969757, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md new file mode 100644 index 0000000000..2b31c39196 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Mark-message-as-unreaded.md @@ -0,0 +1,68 @@ +--- +sidebar_position: 7 +--- + +# Отметить сообщение как непрочитанное + Отмечает выбранное сообщение и все сообщения после него как непрочитанные + + + +`Функция ОтметитьСообщениеКакНепрочитанное(Знач URL, Знач IDЧата, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | IDСообщения | --message | Строка, Число | ID послднего непрочитанного сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDЧата, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = OPI_Bitrix24.ОтметитьСообщениеКакНепрочитанное(URL, IDПользователя, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтметитьСообщениеКакНепрочитанное --url %url% --chat %chat% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969158.8803, + "finish": 1720969158.91584, + "duration": 0.035538911819458, + "processing": 0.0112378597259521, + "date_start": "2024-07-14T14:59:18+00:00", + "date_finish": "2024-07-14T14:59:18+00:00", + "operating_reset_at": 1720969758, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-file.md b/docs/ru/md/Bitrix24/Message-management/Send-file.md new file mode 100644 index 0000000000..d1911786cf --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Send-file.md @@ -0,0 +1,144 @@ +--- +sidebar_position: 5 +--- + +# Отправить файл + Отправляет файл диска в чат по ID + + + +`Функция ОтправитьФайл(Знач URL, Знач IDЧата, Знач IDФайла, Знач Описание = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата | + | IDФайла | --fileid | Строка, Число | ID файла, загруженного при помощи ЗагрузитьФайлВКаталог | + | Описание | --description | Строка | Описание файла | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = ПараметрыФункции["Bitrix24_HookChatID"]; + Файл = ПараметрыФункции["Document"]; // Двоичные данные, URL или путь к файлу + Описание = "Очень важный файл"; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЧата = ПараметрыФункции["Bitrix24_ChatID"]; + + Каталог = OPI_Bitrix24.ПолучитьКаталогФайловЧата(URL, IDЧата, Токен); + IDКаталога = Каталог["result"]["ID"]; + + ЗагруженныйФайл = OPI_Bitrix24.ЗагрузитьФайлВКаталог(URL, "Важный документ.docx", Файл, IDКаталога, Токен); + IDФайла = ЗагруженныйФайл["result"]["ID"]; + + Результат = OPI_Bitrix24.ОтправитьФайл(URL, IDЧата, IDФайла, Описание, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтправитьФайл --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "FILES": { + "upload3254": { + "id": 3254, + "chatId": 254, + "date": {}, + "type": "file", + "name": "Важный документ.docx", + "extension": "docx", + "size": 24071, + "image": false, + "status": "done", + "progress": 100, + "authorId": 1, + "authorName": "Антон Титовец", + "urlPreview": "", + "urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerAttrs": { + "viewer": null, + "viewerType": "cloud-document", + "src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx", + "viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem", + "viewerSeparateItem": true, + "viewerExtension": "im.integration.viewer", + "objectId": "3254", + "imChatId": 254, + "title": "Важный документ.docx", + "actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Сохранить на Битрикс24 Диск\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]" + } + } + }, + "DISK_ID": [ + "3254" + ], + "FILE_MODELS": { + "upload3254": { + "id": 3254, + "name": "Важный документ.docx", + "createTime": {}, + "updateTime": {}, + "deleteTime": null, + "code": null, + "xmlId": null, + "storageId": 6, + "realObjectId": 3254, + "parentId": 3250, + "deletedType": 0, + "createdBy": "1", + "updatedBy": "1", + "deletedBy": "0", + "typeFile": 4, + "globalContentVersion": 2, + "fileId": 2330, + "size": 24071, + "etag": "1179305ea90d0b0fef106e1163deaeb8", + "links": { + "download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254", + "showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1" + } + } + }, + "MESSAGE_ID": 5346 + }, + "time": { + "start": 1720969175.0006, + "finish": 1720969175.09084, + "duration": 0.0902431011199951, + "processing": 0.0652461051940918, + "date_start": "2024-07-14T14:59:35+00:00", + "date_finish": "2024-07-14T14:59:35+00:00", + "operating_reset_at": 1720969775, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Send-message.md b/docs/ru/md/Bitrix24/Message-management/Send-message.md new file mode 100644 index 0000000000..077b1e1999 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Send-message.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 1 +--- + +# Отправить сообщение + Отправляет сообщение в диалог + + + +`Функция ОтправитьСообщение(Знач URL, Знач IDЧата, Знач Текст, Знач Вложения = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЧата | --chat | Строка, Число | ID чата (chatXXX) или пользователя (XXX) для диалога | + | Текст | --text | Строка | Текст сообщения | + | Вложения | --blocks | Массив из Структура | Массив блоков вложений | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЧата = "chat" + ПараметрыФункции["Bitrix24_HookChatID"]; + Текст = "Текст сообщения"; + Картинка = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg"; + Файл = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx"; + + Вложения = Новый Массив; + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокКартинки("Картинка1", Картинка)); + Вложения.Добавить(OPI_Bitrix24.ПолучитьБлокФайла("Файл1.docx", Файл)); + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDЧата, Текст, Вложения); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDПользователя = 10; + + Результат = OPI_Bitrix24.ОтправитьСообщение(URL, IDПользователя, Текст, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ОтправитьСообщение --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token% + +``` + +```json title="Результат" +{ + "result": 5342, + "time": { + "start": 1720969163.89343, + "finish": 1720969163.95538, + "duration": 0.061945915222168, + "processing": 0.0366020202636719, + "date_start": "2024-07-14T14:59:23+00:00", + "date_finish": "2024-07-14T14:59:23+00:00", + "operating_reset_at": 1720969763, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md new file mode 100644 index 0000000000..9c6bbc00a2 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/Set-message-reaction.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 3 +--- + +# Установить реакцию на сообщение + Устанавливает или снимает реакцию на сообщение + + + +`Функция УстановитьРеакциюНаСообщение(Знач URL, Знач IDСообщения, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDСообщения | --message | Строка, Число | ID сообщения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDСообщения = ПараметрыФункции["Bitrix24_ChatMessageID"]; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDСообщения = ПараметрыФункции["Bitrix24_UserMessageID"]; + + Результат = OPI_Bitrix24.УстановитьРеакциюНаСообщение(URL, IDСообщения, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УстановитьРеакциюНаСообщение --url %url% --message %message% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720969166.51361, + "finish": 1720969166.55322, + "duration": 0.0396139621734619, + "processing": 0.0151541233062744, + "date_start": "2024-07-14T14:59:26+00:00", + "date_finish": "2024-07-14T14:59:26+00:00", + "operating_reset_at": 1720969766, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Message-management/_category_.json b/docs/ru/md/Bitrix24/Message-management/_category_.json new file mode 100644 index 0000000000..5f94ed7867 --- /dev/null +++ b/docs/ru/md/Bitrix24/Message-management/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с сообщениями", +"position": "13" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json b/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json deleted file mode 100644 index e16be17d7e..0000000000 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ -"label": "Работа с диском и файлами", -"position": "7" -} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md similarity index 93% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md rename to docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md index 2947b5dbef..a8bfb36719 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Create-storage-folder.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Create-storage-folder.md @@ -1,82 +1,85 @@ ---- -sidebar_position: 7 ---- - -# Создать каталог в хранилище - Создает пустой каталог в хранилище - - - -`Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка | Идентификатор хранилища | - | Наименование | --title | Строка | Имя каталога | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - IDХранилища = 3; - Наименование = "Новый каталог"; - Наименование2 = "Новый каталог 2"; - - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - - Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование2); - - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 СоздатьКаталогВХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": 574, - "NAME": "Новый каталог", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "folder", - "REAL_OBJECT_ID": 574, - "PARENT_ID": "3", - "DELETED_TYPE": 0, - "CREATE_TIME": "2024-06-22T09:07:36+00:00", - "UPDATE_TIME": "2024-06-22T09:07:36+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": null, - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" - }, - "time": { - "start": 1719047256.22025, - "finish": 1719047256.27758, - "duration": 0.057330846786499, - "processing": 0.0276291370391846, - "date_start": "2024-06-22T09:07:36+00:00", - "date_finish": "2024-06-22T09:07:36+00:00", - "operating_reset_at": 1719047856, - "operating": 0 - } -} -``` +--- +sidebar_position: 6 +--- + +# Создать каталог в хранилище + Создает пустой каталог в хранилище + + + +`Функция СоздатьКаталогВХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка | Идентификатор хранилища | + | Наименование | --title | Строка | Имя каталога | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php) +::: +
+ + +```bsl title="Пример кода" + IDХранилища = 3; + Наименование = "Новый каталог"; + Наименование2 = "Новый каталог 2"; + + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + + Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование2); + + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.СоздатьКаталогВХранилище(URL, IDХранилища, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 СоздатьКаталогВХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": 574, + "NAME": "Новый каталог", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "folder", + "REAL_OBJECT_ID": 574, + "PARENT_ID": "3", + "DELETED_TYPE": 0, + "CREATE_TIME": "2024-06-22T09:07:36+00:00", + "UPDATE_TIME": "2024-06-22T09:07:36+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": null, + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/Новый каталог" + }, + "time": { + "start": 1719047256.22025, + "finish": 1719047256.27758, + "duration": 0.057330846786499, + "processing": 0.0276291370391846, + "date_start": "2024-06-22T09:07:36+00:00", + "date_finish": "2024-06-22T09:07:36+00:00", + "operating_reset_at": 1719047856, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md similarity index 89% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md rename to docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md index 4c83dfed5e..af5c25e2a3 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-app-sotrage.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-app-sotrage.md @@ -1,40 +1,43 @@ ---- -sidebar_position: 2 ---- - -# Получить хранилище приложения - Получает информацию о хранилище с которым может работать приложение для хранения своих данных - - - -`Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьХранилищеПриложения --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." - -``` - - +--- +sidebar_position: 2 +--- + +# Получить хранилище приложения + Получает информацию о хранилище с которым может работать приложение для хранения своих данных + + + +`Функция ПолучитьХранилищеПриложения(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php) +::: +
+ + +```bsl title="Пример кода" + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьХранилищеПриложения(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьХранилищеПриложения --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + + diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md similarity index 96% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md rename to docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md index 88f9ba7b41..a741d237c9 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage-objects.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storage-objects.md @@ -1,102 +1,105 @@ ---- -sidebar_position: 5 ---- - -# Получить содержимое хранилища - Получает список файлов и каталогов, находящихся в корне хранилища - - - -`Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - IDХранилища = 3; - Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСодержимоеХранилища --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "568", - "NAME": "Картинка2.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "558", - "SIZE": "2114023", - "CREATE_TIME": "2024-06-22T09:07:30+00:00", - "UPDATE_TIME": "2024-06-22T09:07:30+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка2.jpg" - }, - { - "ID": "570", - "NAME": "Картинка1.jpg", - "CODE": null, - "STORAGE_ID": "3", - "TYPE": "file", - "PARENT_ID": "3", - "DELETED_TYPE": "0", - "GLOBAL_CONTENT_VERSION": "1", - "FILE_ID": "560", - "SIZE": "805189", - "CREATE_TIME": "2024-06-22T09:07:32+00:00", - "UPDATE_TIME": "2024-06-22T09:07:32+00:00", - "DELETE_TIME": null, - "CREATED_BY": "1", - "UPDATED_BY": "1", - "DELETED_BY": "0", - "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", - "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" - } - ], - "total": 2, - "time": { - "start": 1719047253.42516, - "finish": 1719047253.47205, - "duration": 0.0468947887420654, - "processing": 0.016359806060791, - "date_start": "2024-06-22T09:07:33+00:00", - "date_finish": "2024-06-22T09:07:33+00:00", - "operating_reset_at": 1719047853, - "operating": 0 - } -} -``` +--- +sidebar_position: 5 +--- + +# Получить содержимое хранилища + Получает список файлов и каталогов, находящихся в корне хранилища + + + +`Функция ПолучитьСодержимоеХранилища(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDХранилища = 3; + Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСодержимоеХранилища(URL, IDХранилища, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСодержимоеХранилища --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "568", + "NAME": "Картинка2.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "558", + "SIZE": "2114023", + "CREATE_TIME": "2024-06-22T09:07:30+00:00", + "UPDATE_TIME": "2024-06-22T09:07:30+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка2.jpg" + }, + { + "ID": "570", + "NAME": "Картинка1.jpg", + "CODE": null, + "STORAGE_ID": "3", + "TYPE": "file", + "PARENT_ID": "3", + "DELETED_TYPE": "0", + "GLOBAL_CONTENT_VERSION": "1", + "FILE_ID": "560", + "SIZE": "805189", + "CREATE_TIME": "2024-06-22T09:07:32+00:00", + "UPDATE_TIME": "2024-06-22T09:07:32+00:00", + "DELETE_TIME": null, + "CREATED_BY": "1", + "UPDATED_BY": "1", + "DELETED_BY": "0", + "DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D", + "DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Картинка1.jpg" + } + ], + "total": 2, + "time": { + "start": 1719047253.42516, + "finish": 1719047253.47205, + "duration": 0.0468947887420654, + "processing": 0.016359806060791, + "date_start": "2024-06-22T09:07:33+00:00", + "date_finish": "2024-06-22T09:07:33+00:00", + "operating_reset_at": 1719047853, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md similarity index 93% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md rename to docs/ru/md/Bitrix24/Storages-managment/Get-storage.md index d9678f8477..dad42de0fe 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storage.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storage.md @@ -1,69 +1,72 @@ ---- -sidebar_position: 3 ---- - -# Получить хранилище - Получает информацию о хранилище по ID - - - -`Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - IDХранилища = 3; - - Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища); - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - "time": { - "start": 1719047247.65416, - "finish": 1719047247.68963, - "duration": 0.0354659557342529, - "processing": 0.00417995452880859, - "date_start": "2024-06-22T09:07:27+00:00", - "date_finish": "2024-06-22T09:07:27+00:00", - "operating_reset_at": 1719047847, - "operating": 0 - } -} -``` +--- +sidebar_position: 3 +--- + +# Получить хранилище + Получает информацию о хранилище по ID + + + +`Функция ПолучитьХранилище(Знач URL, Знач IDХранилища, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + IDХранилища = 3; + + Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьХранилище(URL, IDХранилища, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + "time": { + "start": 1719047247.65416, + "finish": 1719047247.68963, + "duration": 0.0354659557342529, + "processing": 0.00417995452880859, + "date_start": "2024-06-22T09:07:27+00:00", + "date_finish": "2024-06-22T09:07:27+00:00", + "operating_reset_at": 1719047847, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md similarity index 95% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md rename to docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md index 6b2a623124..1d4f4126f3 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Get-storages-list.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Get-storages-list.md @@ -1,123 +1,126 @@ ---- -sidebar_position: 1 ---- - -# Получить список хранилищ - Получает список доступных хранилищ файлов - - - -`Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -
- - - - -```bsl title="Пример кода" - URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; - Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); - - - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - - Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокХранилищ --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": [ - { - "ID": "3", - "NAME": "Общий диск", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "common", - "ENTITY_ID": "shared_files_s1", - "ROOT_OBJECT_ID": "3" - }, - { - "ID": "1", - "NAME": "Антон Титовец", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "1", - "ROOT_OBJECT_ID": "1" - }, - { - "ID": "16", - "NAME": "iscript13@gmail.com", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "10", - "ROOT_OBJECT_ID": "270" - }, - { - "ID": "4", - "NAME": "Payment Processing Customer Support", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "4" - }, - { - "ID": "10", - "NAME": "CoPilot", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "4", - "ROOT_OBJECT_ID": "52" - }, - { - "ID": "12", - "NAME": "Поддержка Битрикс24", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "6", - "ROOT_OBJECT_ID": "70" - }, - { - "ID": "14", - "NAME": "Марта", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "user", - "ENTITY_ID": "8", - "ROOT_OBJECT_ID": "72" - } - ], - "total": 7, - "time": { - "start": 1718783911.64028, - "finish": 1718783911.69026, - "duration": 0.0499801635742188, - "processing": 0.00660109519958496, - "date_start": "2024-06-19T07:58:31+00:00", - "date_finish": "2024-06-19T07:58:31+00:00", - "operating_reset_at": 1718784511, - "operating": 0 - } -} -``` +--- +sidebar_position: 1 +--- + +# Получить список хранилищ + Получает список доступных хранилищ файлов + + + +`Функция ПолучитьСписокХранилищ(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; + Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL); + + + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + + Результат = OPI_Bitrix24.ПолучитьСписокХранилищ(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокХранилищ --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "3", + "NAME": "Общий диск", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "common", + "ENTITY_ID": "shared_files_s1", + "ROOT_OBJECT_ID": "3" + }, + { + "ID": "1", + "NAME": "Антон Титовец", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "1", + "ROOT_OBJECT_ID": "1" + }, + { + "ID": "16", + "NAME": "iscript13@gmail.com", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "10", + "ROOT_OBJECT_ID": "270" + }, + { + "ID": "4", + "NAME": "Payment Processing Customer Support", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "4" + }, + { + "ID": "10", + "NAME": "CoPilot", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "4", + "ROOT_OBJECT_ID": "52" + }, + { + "ID": "12", + "NAME": "Поддержка Битрикс24", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "6", + "ROOT_OBJECT_ID": "70" + }, + { + "ID": "14", + "NAME": "Марта", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "user", + "ENTITY_ID": "8", + "ROOT_OBJECT_ID": "72" + } + ], + "total": 7, + "time": { + "start": 1718783911.64028, + "finish": 1718783911.69026, + "duration": 0.0499801635742188, + "processing": 0.00660109519958496, + "date_start": "2024-06-19T07:58:31+00:00", + "date_finish": "2024-06-19T07:58:31+00:00", + "operating_reset_at": 1718784511, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-storage.md b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md similarity index 87% rename from docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-storage.md rename to docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md index b326db2656..672932842a 100644 --- a/docs/ru/md/Bitrix24/Storages-and-files-managment/Rename-storage.md +++ b/docs/ru/md/Bitrix24/Storages-managment/Rename-storage.md @@ -1,66 +1,69 @@ ---- -sidebar_position: 4 ---- - -# Переименовать хранилище - Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) - - - -`Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | - | Наименование | --title | Строка | Новое наименование хранилища | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: HTTPОтвет - Переименовать хранилище - -
- - - - -```bsl title="Пример кода" - Наименование = "Новое имя хранилища"; - URL = "b24-ar17wx.bitrix24.by"; - Токен = "b9df7366006e9f06006b12e400000001000..."; - IDХранилища = "18"; - - Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); -``` - - - -```sh title="Пример команды CLI" - - oint bitrix24 ПереименоватьХранилище --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." - -``` - -```json title="Результат" -{ - "result": { - "ID": "18", - "NAME": "Новое имя хранилища", - "CODE": null, - "MODULE_ID": "disk", - "ENTITY_TYPE": "restapp", - "ENTITY_ID": "2", - "ROOT_OBJECT_ID": "464" - }, - "time": { - "start": 1719047246.29499, - "finish": 1719047246.35783, - "duration": 0.062842845916748, - "processing": 0.0317339897155762, - "date_start": "2024-06-22T09:07:26+00:00", - "date_finish": "2024-06-22T09:07:26+00:00", - "operating_reset_at": 1719047846, - "operating": 0 - } -} -``` +--- +sidebar_position: 4 +--- + +# Переименовать хранилище + Изменяет имя хранилища (только для хранилища приложения см. ПолучитьСписокХранилищПриложения) + + + +`Функция ПереименоватьХранилище(Знач URL, Знач IDХранилища, Знач Наименование, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDХранилища | --storageid | Строка, Число | Идентификатор хранилища | + | Наименование | --title | Строка | Новое наименование хранилища | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php) +::: +
+ + +```bsl title="Пример кода" + Наименование = "Новое имя хранилища"; + URL = "b24-ar17wx.bitrix24.by"; + Токен = "b9df7366006e9f06006b12e400000001000..."; + IDХранилища = "18"; + + Результат = OPI_Bitrix24.ПереименоватьХранилище(URL, IDХранилища, Наименование, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПереименоватьХранилище --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..." + +``` + +```json title="Результат" +{ + "result": { + "ID": "18", + "NAME": "Новое имя хранилища", + "CODE": null, + "MODULE_ID": "disk", + "ENTITY_TYPE": "restapp", + "ENTITY_ID": "2", + "ROOT_OBJECT_ID": "464" + }, + "time": { + "start": 1719047246.29499, + "finish": 1719047246.35783, + "duration": 0.062842845916748, + "processing": 0.0317339897155762, + "date_start": "2024-06-22T09:07:26+00:00", + "date_finish": "2024-06-22T09:07:26+00:00", + "operating_reset_at": 1719047846, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Storages-managment/_category_.json b/docs/ru/md/Bitrix24/Storages-managment/_category_.json new file mode 100644 index 0000000000..67a1ee0e86 --- /dev/null +++ b/docs/ru/md/Bitrix24/Storages-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с хранилищами", +"position": "9" +} \ No newline at end of file diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md new file mode 100644 index 0000000000..3fe1c007a6 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md @@ -0,0 +1,71 @@ +--- +sidebar_position: 1 +--- + +# Добавить элемент чеклиста задачи + Добавляет новый элемент чеклиста задачи + + + +`Функция ДобавитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач Текст, Знач Выполнен = Ложь, Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Текст | --text | Строка | Текст (заголовок) пункта чек листа | + | Выполнен | --complete | Булево | Отметить пункт как выполненный | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + + Текст = "Пункт чек-листа"; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, Истина); + + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + + Результат = OPI_Bitrix24.ДобавитьЭлементЧеклистаЗадачи(URL, IDЗадачи, Текст, , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьЭлементЧеклистаЗадачи --url %url% --task %task% --text %text% --complete %complete% --token %token% + +``` + +```json title="Результат" +{ + "result": 96, + "time": { + "start": 1720816505.3041, + "finish": 1720816505.37014, + "duration": 0.0660440921783447, + "processing": 0.0380921363830566, + "date_start": "2024-07-12T20:35:05+00:00", + "date_finish": "2024-07-12T20:35:05+00:00", + "operating_reset_at": 1720817105, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md new file mode 100644 index 0000000000..824a1bc792 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 6 +--- + +# Выполнить элемент чеклиста задачи + Помечает элемент чеклиста задачи как выполненный + + + +`Функция ВыполнитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ВыполнитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВыполнитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816509.8981, + "finish": 1720816509.94922, + "duration": 0.0511200428009033, + "processing": 0.0246191024780273, + "date_start": "2024-07-12T20:35:09+00:00", + "date_finish": "2024-07-12T20:35:09+00:00", + "operating_reset_at": 1720817109, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md new file mode 100644 index 0000000000..e0ede5275f --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 3 +--- + +# Удалить элемент чеклиста задачи + Удаляет элемент из чеклиста задачи + + + +`Функция УдалитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента для удаления | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.УдалитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816512.25818, + "finish": 1720816512.30984, + "duration": 0.0516610145568848, + "processing": 0.0264489650726318, + "date_start": "2024-07-12T20:35:12+00:00", + "date_finish": "2024-07-12T20:35:12+00:00", + "operating_reset_at": 1720817112, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md new file mode 100644 index 0000000000..063e774367 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 5 +--- + +# Получить элемент чеклиста задачи + Получить элемент чеклиста задачи по ID + + + +`Функция ПолучитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента для получения | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "Новый текст пункта чек-листа", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + "time": { + "start": 1720816508.81324, + "finish": 1720816508.85536, + "duration": 0.0421209335327148, + "processing": 0.0174088478088379, + "date_start": "2024-07-12T20:35:08+00:00", + "date_finish": "2024-07-12T20:35:08+00:00", + "operating_reset_at": 1720817108, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md new file mode 100644 index 0000000000..6aba3200bb --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md @@ -0,0 +1,95 @@ +--- +sidebar_position: 4 +--- + +# Получить чеклист задачи + Получает список элементов чеклиста задачи + + + +`Функция ПолучитьЧеклистЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + + Результат = OPI_Bitrix24.ПолучитьЧеклистЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьЧеклистЗадачи --url %url% --task %task% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "94", + "TASK_ID": "632", + "PARENT_ID": 0, + "CREATED_BY": "1", + "TITLE": "BX_CHECKLIST_1", + "SORT_INDEX": "0", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + }, + { + "ID": "96", + "TASK_ID": "632", + "PARENT_ID": "94", + "CREATED_BY": "1", + "TITLE": "Новый текст пункта чек-листа", + "SORT_INDEX": "1", + "IS_COMPLETE": "N", + "IS_IMPORTANT": "N", + "TOGGLED_BY": null, + "TOGGLED_DATE": "", + "MEMBERS": [], + "ATTACHMENTS": [] + } + ], + "time": { + "start": 1720816507.68937, + "finish": 1720816507.74166, + "duration": 0.0522880554199219, + "processing": 0.0231881141662598, + "date_start": "2024-07-12T20:35:07+00:00", + "date_finish": "2024-07-12T20:35:07+00:00", + "operating_reset_at": 1720817107, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md new file mode 100644 index 0000000000..30ba12aac7 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 7 +--- + +# Возобновить элемент чеклиста задачи + Снимает пометку элемента как выполненного + + + +`Функция ВозобновитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента); + + + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ВозобновитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ВозобновитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --token %token% + +``` + +```json title="Результат" +{ + "result": true, + "time": { + "start": 1720816511.09347, + "finish": 1720816511.14508, + "duration": 0.051609992980957, + "processing": 0.0250108242034912, + "date_start": "2024-07-12T20:35:11+00:00", + "date_finish": "2024-07-12T20:35:11+00:00", + "operating_reset_at": 1720817111, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md new file mode 100644 index 0000000000..37090d717e --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 2 +--- + +# Изменить элемент чеклиста задачи + Изменяет текст элемента чеклиста задачи + + + +`Функция ИзменитьЭлементЧеклистаЗадачи(Знач URL, Знач IDЗадачи, Знач IDЭлемента, Знач Текст, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Число, Строка | ID задачи | + | IDЭлемента | --element | Число, Строка | ID элемента чеклиста | + | Текст | --text | Строка | Текст (заголовок) пункта чек листа | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_HookTaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_HookCheckElementID"]; + + Текст = "Новый текст пункта чек-листа"; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗадачи = ПараметрыФункции["Bitrix24_TaskID"]; + IDЭлемента = ПараметрыФункции["Bitrix24_CheckElementID"]; + + Результат = OPI_Bitrix24.ИзменитьЭлементЧеклистаЗадачи(URL, IDЗадачи, IDЭлемента, Текст, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьЭлементЧеклистаЗадачи --url %url% --task %task% --element %element% --text %text% --token %token% + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720816506.52861, + "finish": 1720816506.58416, + "duration": 0.0555450916290283, + "processing": 0.027979850769043, + "date_start": "2024-07-12T20:35:06+00:00", + "date_finish": "2024-07-12T20:35:06+00:00", + "operating_reset_at": 1720817106, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json b/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json new file mode 100644 index 0000000000..ce756bd819 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-checklists-managment/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Работа с чеклистами задач", +"position": "5" +} \ 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 ec4125f0d5..08ebb03337 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 @@ -20,7 +20,10 @@ sidebar_position: 17
- +:::tip +Метод в документации API: [tasks.task.favorite.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_add.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md index ca3e7002d8..94fb60521c 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Approve-task.md @@ -20,7 +20,10 @@ sidebar_position: 7
- +:::tip +Метод в документации API: [tasks.task.approve](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_approve.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md index 30ee5ffecf..dc09b0e537 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md @@ -21,7 +21,10 @@ sidebar_position: 6
- +:::tip +Метод в документации API: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md index 27cd88ee08..5323a9ec36 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Check-task-accesses.md @@ -21,7 +21,10 @@ sidebar_position: 20
- +:::tip +Метод в документации API: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md index 24ac2861f1..ac38e3a5ec 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Complete-task.md @@ -20,7 +20,10 @@ sidebar_position: 9
- +:::tip +Метод в документации API: [tasks.task.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_complete.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md index 6547a2d6cf..ed510bec79 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-task.md @@ -20,7 +20,10 @@ sidebar_position: 3
- +:::tip +Метод в документации API: [tasks.task.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_add.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md index 7366488832..c42ffc92a7 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md @@ -22,7 +22,10 @@ sidebar_position: 23
- +:::tip +Метод в документации API: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md index e74247fa99..35a66b5d5c 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Defer-task.md @@ -20,7 +20,10 @@ sidebar_position: 11
- +:::tip +Метод в документации API: [tasks.task.defer](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_defer.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md index 73637d71a6..b0ece1b3e4 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delegate-task.md @@ -21,7 +21,10 @@ sidebar_position: 16
- +:::tip +Метод в документации API: [tasks.task.delegate](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delegate.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md index ad96f4cff8..d8ecd5a77f 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-task.md @@ -20,7 +20,10 @@ sidebar_position: 5
- +:::tip +Метод в документации API: [tasks.task.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_delete.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md index f80270fc95..6bd2a2e50b 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md @@ -22,7 +22,10 @@ sidebar_position: 24
- +:::tip +Метод в документации API: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php) +::: +
@@ -34,4 +37,18 @@ sidebar_position: 24 ``` - +```json title="Результат" +{ + "result": [], + "time": { + "start": 1720816479.3837, + "finish": 1720816479.41872, + "duration": 0.0350160598754883, + "processing": 0.00787091255187988, + "date_start": "2024-07-12T20:34:39+00:00", + "date_finish": "2024-07-12T20:34:39+00:00", + "operating_reset_at": 1720817079, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md index 0af5ce5c74..39779f3cd6 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Disapprove-task.md @@ -20,7 +20,10 @@ sidebar_position: 8
- +:::tip +Метод в документации API: [tasks.task.disapprove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_disapprove.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-comments-filter-structure.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-comments-filter-structure.md deleted file mode 100644 index 2ab7d77396..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-comments-filter-structure.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 22 ---- - -# Получить структуру фильтра комментариев - Возвращает структуру полей для фильтрации комментариев в методе ПолучитьСписокКомментариевЗадачи - - -*Функция ПолучитьСтруктуруФильтраКомментариев(Знач Пустая = Ложь) Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | Пустая | --empty | Булево | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | - - - Возвращаемое значение: Структура Из КлючИЗначение - Структура полей - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСтруктуруФильтраКомментариев --empty %empty% - -``` - - -```json title="Результат" - - - -``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md new file mode 100644 index 0000000000..2c85c19f48 --- /dev/null +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-daily-plan.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 25 +--- + +# Получить план задач на день + Получает план задач на день текущего пользователя + + + +`Функция ПолучитьПланЗадачНаДень(Знач URL, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьПланЗадачНаДень(URL, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьПланЗадачНаДень --url %url% --token %token% + +``` + +```json title="Результат" +{ + "result": [], + "time": { + "start": 1720816513.42336, + "finish": 1720816513.45192, + "duration": 0.0285580158233643, + "processing": 0.000265121459960938, + "date_start": "2024-07-12T20:35:13+00:00", + "date_finish": "2024-07-12T20:35:13+00:00", + "operating_reset_at": 1720817113, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-comments-list.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-comments-list.md deleted file mode 100644 index 0195ad0d54..0000000000 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-comments-list.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -sidebar_position: 20 ---- - -# Получить список комментариев задачи - Полчает список комментариев пользователей к задаче по ID - - -*Функция ПолучитьСписокКомментариевЗадачи(Знач URL, Знач IDЗадачи, Знач Фильтр = "", Знач Токен = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | - | IDЗадачи | --task | Число,Строка | ID задачи | - | Фильтр | --filter | Структура из КлючИЗначение | Структура отбора (см. ПолучитьСтруктуруФильтраКомментариев) | - | Токен | --token | Строка | Токен авторизации, если используется не вебхук | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 - -```bsl title="Пример кода" - - - -``` - -```sh title="Пример команды CLI" - - oint bitrix24 ПолучитьСписокКомментариевЗадачи --url %url% --task %task% --filter %filter% --token %token% - -``` - - -```json title="Результат" - - - -``` 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 838a36afd2..b7a1a5b5e7 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,5 +1,5 @@ --- -sidebar_position: 25 +sidebar_position: 26 --- # Получить структуру задачи @@ -19,7 +19,10 @@ sidebar_position: 25
- +:::tip +Метод в документации API: [tasks.task.getFields](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getFields.php) +::: +
```bsl title="Пример кода" 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 c310e91bcb..4d5ee98c03 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task-history.md @@ -20,7 +20,10 @@ sidebar_position: 19
- +:::tip +Метод в документации API: [tasks.task.history.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_history_list.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md index 73a5bfbae8..1944a5115b 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-task.md @@ -20,7 +20,10 @@ sidebar_position: 1
- +:::tip +Метод в документации API: [tasks.task.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_get.php) +::: +
```bsl title="Пример кода" 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 4576ff8873..3755056e03 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,5 +1,5 @@ --- -sidebar_position: 26 +sidebar_position: 27 --- # Получить структуру фильтра задач 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 31a06b7059..2a500110cb 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Get-tasks-list.md @@ -21,7 +21,10 @@ sidebar_position: 2
- +:::tip +Метод в документации API: [tasks.task.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_list.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md index 18f1a73f2a..ba32b0d01d 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Mute-task.md @@ -20,7 +20,10 @@ sidebar_position: 21
- +:::tip +Метод в документации API: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md index addcc2305d..61bcdf8bd3 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Pause-task.md @@ -20,7 +20,10 @@ sidebar_position: 12
- +:::tip +Метод в документации API: [tasks.task.pause](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_pause.php) +::: +
```bsl title="Пример кода" 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 739927f80b..154c344211 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 @@ -20,7 +20,10 @@ sidebar_position: 18
- +:::tip +Метод в документации API: [tasks.task.favorite.remove](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_favorite_remove.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md index 5bca58d8d7..44bb753a12 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Renew-task.md @@ -20,7 +20,10 @@ sidebar_position: 10
- +:::tip +Метод в документации API: [tasks.task.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_renew.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md index a0447357cc..f54b07d845 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Start-task.md @@ -20,7 +20,10 @@ sidebar_position: 13
- +:::tip +Метод в документации API: [tasks.task.start](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_start.php) +::: +
```bsl title="Пример кода" 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 5f761bd7e8..4a9e52e628 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Start-watching-task.md @@ -20,7 +20,10 @@ sidebar_position: 14
- +:::tip +Метод в документации API: [tasks.task.startwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_startwatch.php) +::: +
```bsl title="Пример кода" 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 0e90aa66fc..25d2929a97 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Stop-watching-task.md @@ -20,7 +20,10 @@ sidebar_position: 15
- +:::tip +Метод в документации API: [tasks.task.stopwatch](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_stopwatch.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md index 2363802c36..088b32abbb 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Unmute-task.md @@ -20,7 +20,10 @@ sidebar_position: 22
- +:::tip +Метод в документации API: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md index e8316a6ef6..c9d73b8a7b 100644 --- a/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md +++ b/docs/ru/md/Bitrix24/Tasks-managment/Update-task.md @@ -21,7 +21,10 @@ sidebar_position: 4
- +:::tip +Метод в документации API: [tasks.task.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_update.php) +::: +
```bsl title="Пример кода" diff --git a/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md new file mode 100644 index 0000000000..f0ec3401e8 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Add-task-time-accounting.md @@ -0,0 +1,82 @@ +--- +sidebar_position: 1 +--- + +# Добавить трудозатраты задачи + Добавляет информацию о затраченном времени пользователя в задачу + + + +`Функция ДобавитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач Время, Знач IDПользователя = "", Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | + | Время | --amount | Строка, Число | Затраченное время в секундах | + | IDПользователя | --user | Строка, Число | ID пользователя, затратившего время | + | Текст | --text | Строка | Текст комментария трудозатраты | + | ДатаУстановки | --date | Строка | Дата установки трудозатрат | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + + Время = 3600; + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL, IDЗадачи, Время); + + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Текст = "Трудозатраты по обработке"; + IDПользователя = 10; + Время = 7200; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = OPI_Bitrix24.ДобавитьТрудозатратыЗадачи(URL + , IDЗадачи + , Время + , IDПользователя + , Текст + , ДатаУстановки + , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ДобавитьТрудозатратыЗадачи --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token% + +``` + +```json title="Результат" +{ + "result": 42, + "time": { + "start": 1720816582.16849, + "finish": 1720816582.22964, + "duration": 0.0611569881439209, + "processing": 0.0315871238708496, + "date_start": "2024-07-12T20:36:22+00:00", + "date_finish": "2024-07-12T20:36:22+00:00", + "operating_reset_at": 1720817182, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md new file mode 100644 index 0000000000..1bd0496d96 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 2 +--- + +# Удалить трудозатраты задачи + Удаляет запись о трудозатратах из задачи + + + +`Функция УдалитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи для добавления затрат | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + IDЗаписи = ПараметрыФункции["Bitrix24_HookTimeID"]; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗаписи = ПараметрыФункции["Bitrix24_TimeID"]; + + Результат = OPI_Bitrix24.УдалитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 УдалитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720816586.91135, + "finish": 1720816586.96255, + "duration": 0.0512039661407471, + "processing": 0.0238111019134522, + "date_start": "2024-07-12T20:36:26+00:00", + "date_finish": "2024-07-12T20:36:26+00:00", + "operating_reset_at": 1720817186, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md new file mode 100644 index 0000000000..68477ce0ac --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting-list.md @@ -0,0 +1,90 @@ +--- +sidebar_position: 3 +--- + +# Получить список трудозатрат задачи + Получает список записей о трудозатратах задачи + + + +`Функция ПолучитьСписокТрудозатратЗадачи(Знач URL, Знач IDЗадачи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/getlist.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + + Результат = OPI_Bitrix24.ПолучитьСписокТрудозатратЗадачи(URL, IDЗадачи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьСписокТрудозатратЗадачи --url %url% --task %task% --token %token% + +``` + +```json title="Результат" +{ + "result": [ + { + "ID": "40", + "TASK_ID": "638", + "USER_ID": "1", + "COMMENT_TEXT": "", + "SECONDS": "3600", + "MINUTES": "60", + "SOURCE": "2", + "CREATED_DATE": "2024-07-12T20:36:21+00:00", + "DATE_START": "2024-07-12T20:36:21+00:00", + "DATE_STOP": "2024-07-12T20:36:21+00:00" + }, + { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Трудозатраты по обработке", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + } + ], + "total": 2, + "time": { + "start": 1720816584.48831, + "finish": 1720816584.5364, + "duration": 0.0480880737304688, + "processing": 0.0219790935516357, + "date_start": "2024-07-12T20:36:24+00:00", + "date_finish": "2024-07-12T20:36:24+00:00", + "operating_reset_at": 1720817184, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md new file mode 100644 index 0000000000..907e9656e3 --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Get-task-time-accounting.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 4 +--- + +# Получить трудозатраты задачи + Получает информацию о записи трудозатрат задачи по ID + + + +`Функция ПолучитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/get.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + IDЗаписи = ПараметрыФункции["Bitrix24_HookTimeID"]; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗаписи = ПараметрыФункции["Bitrix24_TimeID"]; + + Результат = OPI_Bitrix24.ПолучитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ПолучитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --token %token% + +``` + +```json title="Результат" +{ + "result": { + "ID": "42", + "TASK_ID": "638", + "USER_ID": "10", + "COMMENT_TEXT": "Трудозатраты по обработке", + "SECONDS": "7200", + "MINUTES": "120", + "SOURCE": "2", + "CREATED_DATE": "2024-06-12T17:36:21+00:00", + "DATE_START": "2024-07-12T20:36:22+00:00", + "DATE_STOP": "2024-07-12T20:36:22+00:00" + }, + "time": { + "start": 1720816583.31997, + "finish": 1720816583.36716, + "duration": 0.0471861362457275, + "processing": 0.0187540054321289, + "date_start": "2024-07-12T20:36:23+00:00", + "date_finish": "2024-07-12T20:36:23+00:00", + "operating_reset_at": 1720817183, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md new file mode 100644 index 0000000000..ecf92e656a --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/Update-task-time-accounting.md @@ -0,0 +1,83 @@ +--- +sidebar_position: 5 +--- + +# Изменить трудозатраты задачи + Изменяет данные записи о трудозатратах задачи + + + +`Функция ИзменитьТрудозатратыЗадачи(Знач URL, Знач IDЗадачи, Знач IDЗаписи, Знач Время, Знач Текст = "", Знач ДатаУстановки = "", Знач Токен = "") Экспорт` + + | Параметр | CLI опция | Тип | Назначение | + |-|-|-|-| + | URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена | + | IDЗадачи | --task | Строка, Число | ID задачи | + | IDЗаписи | --record | Строка, Число | ID записи о трудозатратах | + | Время | --amount | Строка, Число | Затраченное время в секундах | + | Текст | --text | Строка | Текст комментария трудозатраты | + | ДатаУстановки | --date | Строка | Дата установки трудозатрат | + | Токен | --token | Строка | Токен авторизации, если используется не вебхук | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24 + +
+ +:::tip +Метод в документации API: [task.elapseditem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/update.php) +::: +
+ + +```bsl title="Пример кода" + URL = ПараметрыФункции["Bitrix24_URL"]; + IDЗадачи = ПараметрыФункции["Bitrix24_ElapsedTaskID"]; + IDЗаписи = ПараметрыФункции["Bitrix24_HookTimeID"]; + + Текст = "Забытый в прошлый раз текст"; + Время = 4800; + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL, IDЗадачи, IDЗаписи, Время, Текст); + + + URL = ПараметрыФункции["Bitrix24_Domain"]; + Токен = ПараметрыФункции["Bitrix24_Token"]; + IDЗаписи = ПараметрыФункции["Bitrix24_TimeID"]; + + Текст = "Новые трудозатраты по обработке"; + Время = 4800; + ДатаУстановки = ДобавитьМесяц(OPI_Инструменты.ПолучитьТекущуюДату(), -1); + + Результат = OPI_Bitrix24.ИзменитьТрудозатратыЗадачи(URL + , IDЗадачи + , IDЗаписи + , Время + , Текст + , ДатаУстановки + , Токен); +``` + + + +```sh title="Пример команды CLI" + + oint bitrix24 ИзменитьТрудозатратыЗадачи --url %url% --task %task% --record %record% --amount %amount% --text %text% --date %date% --token %token% + +``` + +```json title="Результат" +{ + "result": null, + "time": { + "start": 1720816585.70407, + "finish": 1720816585.77088, + "duration": 0.0668020248413086, + "processing": 0.0276288986206055, + "date_start": "2024-07-12T20:36:25+00:00", + "date_finish": "2024-07-12T20:36:25+00:00", + "operating_reset_at": 1720817185, + "operating": 0 + } +} +``` diff --git a/docs/ru/md/Bitrix24/Timekeeping/_category_.json b/docs/ru/md/Bitrix24/Timekeeping/_category_.json new file mode 100644 index 0000000000..03cdb8aa1d --- /dev/null +++ b/docs/ru/md/Bitrix24/Timekeeping/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Учет рабочего времени", +"position": "8" +} \ No newline at end of file diff --git a/docs/ru/md/Instructions/Airtable.md b/docs/ru/md/Instructions/Airtable.md deleted file mode 100644 index a29921a60f..0000000000 --- a/docs/ru/md/Instructions/Airtable.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: Airtable -sidebar_class_name: Airtable ---- - - - -# Airtable - -Этот раздел посвящен библиотеке для работы с Airtable API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -1. Авторизуйтесь в Airtable и перейдите **[на страницу создания персональных токенов](https://airtable.com/create/tokens)**, нажмите **Create new token** - -![BF](../../static/img/Docs/Airtable/1.png) - -2. Введите название для нового токена, выберите из перечня необходимые **Scopes** (разрешения) и **Access** (базы и рабочие пространства, к которым у токена будет доступ) - -![BF](../../static/img/Docs/Airtable/2.png) - -3. Скопируйте новый **токен** - -![BF](../../static/img/Docs/Airtable/3.png) diff --git a/docs/ru/md/Instructions/Bitrix24.md b/docs/ru/md/Instructions/Bitrix24.md deleted file mode 100644 index 5d411cfd91..0000000000 --- a/docs/ru/md/Instructions/Bitrix24.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: Bitrix24 -sidebar_class_name: Bitrix24 ---- - - - -# Bitrix24 - -Этот раздел посвящен библиотеке для работы с Bitrix24 API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -Работать и Bitrix24 через API можно двумя способами: через **Webhook** и через **локальное приложение**. Для обоих вариантов необходимо: - -1. Перейти в подраздел **Разработчикам** в разделе **Приложения** боковой панели - -![BF](../../static/img/Docs/Bitrix24/1.png) - -2. Выбрать пункт **Другое** - -![BF](../../static/img/Docs/Bitrix24/2.png) - -

- -### Для работы через Webhook - -1. Выберите пункт **Входящий вебхук** - -![BF](../../static/img/Docs/Bitrix24/3.png) - -2. Заполните необходимые разрешения в **Настройках прав** и сохраните URL вебхука. Он будет использоваться для выполнения методов библиотеки как параметр **URL**. Необязательный параметр **Токен** в данном случае будет всегда оставаться пустым - -![BF](../../static/img/Docs/Bitrix24/4.png) - -

- -## Для работы через Локальное приложение - -1. Выберите пункт **Локальное приложение** - -![BF](../../static/img/Docs/Bitrix24/5.png) - -2. Выберите путь обработчика (если приложение не подразумевает авторизацию других пользователей, но только управление Bitrix через один аккаунт администратора, то можно выбрать любой адрес, например https://localhost), поставьте галочку **Использует только API** (если необходим только функционал вызова методов библиотеки) и заполните необходимые права - -![BF](../../static/img/Docs/Bitrix24/6.png) - -3. Сохраните **ключ** и **код** приложения - -![BF](../../static/img/Docs/Bitrix24/7.png) - -4. При помощи ключа приложения вызовите функцию **ПолучитьСсылкуАвторизацииПриложения** и перейдите по полученной ссылке в браузере. После авторизации, скопируйте полученный код из адресной строки (или получите его на обработчик, адрес которого был указан в пункте 2) - -![BF](../../static/img/Docs/Bitrix24/8.png) - -5. Передайте полученный код, вместе с ключем и секретом приложения, в функцию **ПолучитьТокен**. Сохраните полученные **access** и **refresh токены** - -6. Время жизни токенов ограничено. Для получение нового токена можно воспользоваться функцией **ОбновитьТокен**, передав тутда refresh токен, ключ и секрет приложения. При обновлении создается не только новый access токен, но и refresh токен тоже - - - - diff --git a/docs/ru/md/Instructions/Dropbox.md b/docs/ru/md/Instructions/Dropbox.md deleted file mode 100644 index 942a258035..0000000000 --- a/docs/ru/md/Instructions/Dropbox.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: Dropbox -sidebar_class_name: Dropbox ---- - - - -# Dropbox - -Этот раздел посвящен библиотеке для работы с Dropbox API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -1. Войдите в свой аккаунт на сайте [Dropbox Developers](https://www.dropbox.com/developers) - -![BF](../../static/img/Docs/Dropbox/1.png) - -1. Перейдите к **App Console** - -![BF](../../static/img/Docs/Dropbox/2.png) - -2. Нажмите **Create app** - -![BF](../../static/img/Docs/Dropbox/3.png) - -4. Введите имя нового приложения и выберите **Full Dropbox** - -![BF](../../static/img/Docs/Dropbox/4.png) - -5. После создания, на странице приложения нажмите **Scoped app** и выберите разрешения, которые необходимы для решения ваших задач. Сохраните **AppKey** и **AppSecret** - -![BF](../../static/img/Docs/Dropbox/5.png) - -6. Получите ссылку авторизации при помощи функции *ПолучитьСсылкуАвторизации(Знач КлючПриложения)* и передите по ней в браузере - -![BF](../../static/img/Docs/Dropbox/6.png) - -7. Передайте **полученный код**, **AppKey** и **AppSecret** в функцию *ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код)*, сохраните полученные **access_token** и **refresh_token** - -8. По истечении времени жизни access_token, его можно обновить при помощи функции *ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен)* \ No newline at end of file diff --git a/docs/ru/md/Instructions/Google_Calendar.md b/docs/ru/md/Instructions/Google_Calendar.md deleted file mode 100644 index df45dc229e..0000000000 --- a/docs/ru/md/Instructions/Google_Calendar.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: GoogleCalendar -sidebar_class_name: GoogleCalendar ---- - - - -# Google Календарь - -Этот раздел посвящен библиотеке для работы с API Google Calendar. На данной странице описаны все действия, необходимые для полноценного начала работы - -:::important -Если вы уже используете ОПИ для работы с другими сервисами Google Workspase и выполняли стартовую настройку, то пункты **Создание проекта** и **Настройка OAuth** можно пропустить. Необходимо лишь **включить сервис Google Drive** в своем проекте и **заново получить токен** (последние два пункта инструкции). -::: - -## Начало работы - -
- -### Создание проекта - -1. Перейдите на [главную страницу Google Cloud](https://console.cloud.google.com) и создайте проект - -![BF](../../static/img/Docs/GoogleCalendar/1.png) - -2. Выберите созданный проект и в боковом меню перейдите APIs and Services -> OAuth consent screen - -![BF](../../static/img/Docs/GoogleCalendar/2.png) - -3. Выберите пункт External - -![BF](../../static/img/Docs/GoogleCalendar/3.png) - -4. Заполните поля App name, User support email и Email addresses (все поля со звездочками) - -![BF](../../static/img/Docs/GoogleCalendar/4.png) - -5. Нажимайте далее и Save and continue на последней вкладке - -![BF](../../static/img/Docs/GoogleCalendar/5.png) - -6. Нажмите Publish App - -![BF](../../static/img/Docs/GoogleCalendar/6.png) - -
- -### Настройка OAuth - -1. В боковом меню выберите пункт Credentials -> Create Credentials -> OAuth client ID - -![BF](../../static/img/Docs/GoogleCalendar/7.png) - -2. Введите имя и выберите Application type - Desktop app - -![BF](../../static/img/Docs/GoogleCalendar/8.png) - -3. Сохраните ClientID и Client Secret - -![BF](../../static/img/Docs/GoogleCalendar/9.png) - -
- -### Включение сервиса Google Calendar - -1. Перейдите на [страницу Календаря в Marketplace](https://console.cloud.google.com/marketplace/product/google/calendar-json.googleapis.com) - -2. Нажмите Enable - -![BF](../../static/img/Docs/GoogleCalendar/12.png) - -
- -### Получение Токена - -1. Передайте ClientID в функцию OPI_GoogleWorkspace.СформироватьСсылкуПолученияКода() с булево параметрами используемых вами сервисов. Результатом функции будет URL, который необходимо открыть в браузере. Авторизуйтесь при помощи своего аккаунта Google - -![BF](../../static/img/Docs/GoogleCalendar/10.png) - -2. Скопируйте код из URL после авторизации - -![BF](../../static/img/Docs/GoogleCalendar/11.png) - -3. Используйте полученный код, ClientID и Client Secret для вызова функции OPI_GoogleWorkspace.ПолучитьТокенПоКоду(ClientID, ClientSecret, Code) - -```json title="Результат функции ПолучитьТокенПоКоду(), если перевести его в JSON" - -{ - "token_type": "Bearer", - "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", - "scope": "https://www.googleapis.com/auth/calendar", - "expires_in": 3599, - "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" -} - -``` - -4. Используйте **access_token** для передачи в качестве параметра Токен при вызове функций библиотеки, а refresh_token - для получения нового access_token (функция OPI_GoogleWorkspace.ОбновитьТокен(ClientID, ClientSecret, RefreshToken)), когда время жизни старого истечет. При обновлении токена refresh_token не обновляется - вы можете использовать его один и тот же для получения нового access_token каждый раз. diff --git a/docs/ru/md/Instructions/Google_Drive.md b/docs/ru/md/Instructions/Google_Drive.md deleted file mode 100644 index 8d897ad8bf..0000000000 --- a/docs/ru/md/Instructions/Google_Drive.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: GoogleDrive -sidebar_class_name: GoogleDrive ---- - - - -# Google Drive - -Этот раздел посвящен библиотеке для работы с API Google Drive. На данной странице описаны все действия, необходимые для полноценного начала работы - -:::important -Если вы уже используете ОПИ для работы с другими сервисами Google Workspase и выполняли стартовую настройку, то пункты **Создание проекта** и **Настройка OAuth** можно пропустить. Необходимо лишь **включить сервис Google Drive** в своем проекте и **заново получить токен** (последние два пункта инструкции). -::: - -## Начало работы - -
- -### Создание проекта - -1. Перейдите на [главную страницу Google Cloud](https://console.cloud.google.com) и создайте проект - -![BF](../../static/img/Docs/GoogleCalendar/1.png) - -2. Выберите созданный проект и в боковом меню перейдите APIs and Services -> OAuth consent screen - -![BF](../../static/img/Docs/GoogleCalendar/2.png) - -3. Выберите пункт External - -![BF](../../static/img/Docs/GoogleCalendar/3.png) - -4. Заполните поля App name, User support email и Email addresses (все поля со звездочками) - -![BF](../../static/img/Docs/GoogleCalendar/4.png) - -5. Нажимайте далее и Save and continue на последней вкладке - -![BF](../../static/img/Docs/GoogleCalendar/5.png) - -6. Нажмите Publish App - -![BF](../../static/img/Docs/GoogleCalendar/6.png) - -
- -### Настройка OAuth - -1. В боковом меню выберите пункт Credentials -> Create Credentials -> OAuth client ID - -![BF](../../static/img/Docs/GoogleCalendar/7.png) - -2. Введите имя и выберите Application type - Desktop app - -![BF](../../static/img/Docs/GoogleCalendar/8.png) - -3. Сохраните ClientID и Client Secret - -![BF](../../static/img/Docs/GoogleCalendar/9.png) - -
- -### Включение сервиса Google Drive - -1. Перейдите на [страницу Drive в Marketplace](https://console.cloud.google.com/marketplace/product/google/drive.googleapis.com) - -2. Нажмите Enable - -![BF](../../static/img/Docs/GoogleDrive/1.png) - -
- -### Получение Токена - -1. Передайте ClientID в функцию OPI_GoogleWorkspace.СформироватьСсылкуПолученияКода() с булево параметрами используемых вами сервисов. Результатом функции будет URL, который необходимо открыть в браузере. Авторизуйтесь при помощи своего аккаунта Google - -![BF](../../static/img/Docs/GoogleCalendar/10.png) - -2. Скопируйте код из URL после авторизации - -![BF](../../static/img/Docs/GoogleCalendar/11.png) - -3. Используйте полученный код, ClientID и Client Secret для вызова функции OPI_GoogleWorkspace.ПолучитьТокенПоКоду(ClientID, ClientSecret, Code) - -```json title="Результат функции ПолучитьТокенПоКоду(), если перевести его в JSON" - -{ - "token_type": "Bearer", - "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", - "scope": "https://www.googleapis.com/auth/...", - "expires_in": 3599, - "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" -} - -``` - -4. Используйте **access_token** для передачи в качестве параметра Токен при вызове функций библиотеки, а refresh_token - для получения нового access_token (функция OPI_GoogleWorkspace.ОбновитьТокен(ClientID, ClientSecret, RefreshToken)), когда время жизни старого истечет. При обновлении токена refresh_token не обновляется - вы можете использовать его один и тот же для получения нового access_token каждый раз. diff --git a/docs/ru/md/Instructions/Google_Sheets.md b/docs/ru/md/Instructions/Google_Sheets.md deleted file mode 100644 index 28c96aa9d8..0000000000 --- a/docs/ru/md/Instructions/Google_Sheets.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: GoogleSheets -sidebar_class_name: GoogleSheets ---- - - - -# Google Sheets - -Этот раздел посвящен библиотеке для работы с API Google Sheets. На данной странице описаны все действия, необходимые для полноценного начала работы - -:::important -Если вы уже используете ОПИ для работы с другими сервисами Google Workspase и выполняли стартовую настройку, то пункты **Создание проекта** и **Настройка OAuth** можно пропустить. Необходимо лишь **включить сервис Google Sheets** в своем проекте и **заново получить токен** (последние два пункта инструкции). -::: - -## Начало работы - -
- -### Создание проекта - -1. Перейдите на [главную страницу Google Cloud](https://console.cloud.google.com) и создайте проект - -![BF](../../static/img/Docs/GoogleCalendar/1.png) - -2. Выберите созданный проект и в боковом меню перейдите APIs and Services -> OAuth consent screen - -![BF](../../static/img/Docs/GoogleCalendar/2.png) - -3. Выберите пункт External - -![BF](../../static/img/Docs/GoogleCalendar/3.png) - -4. Заполните поля App name, User support email и Email addresses (все поля со звездочками) - -![BF](../../static/img/Docs/GoogleCalendar/4.png) - -5. Нажимайте далее и Save and continue на последней вкладке - -![BF](../../static/img/Docs/GoogleCalendar/5.png) - -6. Нажмите Publish App - -![BF](../../static/img/Docs/GoogleCalendar/6.png) - -
- -### Настройка OAuth - -1. В боковом меню выберите пункт Credentials -> Create Credentials -> OAuth client ID - -![BF](../../static/img/Docs/GoogleCalendar/7.png) - -2. Введите имя и выберите Application type - Desktop app - -![BF](../../static/img/Docs/GoogleCalendar/8.png) - -3. Сохраните ClientID и Client Secret - -![BF](../../static/img/Docs/GoogleCalendar/9.png) - -
- -### Включение сервиса Google Sheets - -1. Перейдите на [страницу Sheets в Marketplace](https://console.cloud.google.com/marketplace/product/google/sheets.googleapis.com) - -2. Нажмите Enable - -![BF](../../static/img/Docs/GoogleSheets/1.png) - -
- -### Получение Токена - -1. Передайте ClientID в функцию OPI_GoogleWorkspace.СформироватьСсылкуПолученияКода() с булево параметрами используемых вами сервисов. Результатом функции будет URL, который необходимо открыть в браузере. Авторизуйтесь при помощи своего аккаунта Google - -![BF](../../static/img/Docs/GoogleCalendar/10.png) - -2. Скопируйте код из URL после авторизации - -![BF](../../static/img/Docs/GoogleCalendar/11.png) - -3. Используйте полученный код, ClientID и Client Secret для вызова функции OPI_GoogleWorkspace.ПолучитьТокенПоКоду(ClientID, ClientSecret, Code) - -```json title="Результат функции ПолучитьТокенПоКоду(), если перевести его в JSON" - -{ - "token_type": "Bearer", - "refresh_token": "1//09au6OES3JN9oCgYIARAAGAkSNwF-L9Ir1B7uawfwafT1wE0FKO519Xj6JxawfawfyjMyJ_QlUZYLHZqw", - "scope": "https://www.googleapis.com/auth/...", - "expires_in": 3599, - "access_token": "ya29.a0AfB_byA344tXkIawdawdwadadhyZQV8bSZn_snNXtY2HLb7l71awdawdawdad-ASgpzyOSWIvEmPruhUa_1yCCq6jvoD0r_q-fNEsARrH8zpJ3c6LNGWvwdg8CXsSxYaCgYKAWkSawfwafawfrCK0EP5kZY_A0171" -} - -``` - -4. Используйте **access_token** для передачи в качестве параметра Токен при вызове функций библиотеки, а refresh_token - для получения нового access_token (функция OPI_GoogleWorkspace.ОбновитьТокен(ClientID, ClientSecret, RefreshToken)), когда время жизни старого истечет. При обновлении токена refresh_token не обновляется - вы можете использовать его один и тот же для получения нового access_token каждый раз. diff --git a/docs/ru/md/Instructions/Notion.md b/docs/ru/md/Instructions/Notion.md deleted file mode 100644 index ceeacdd945..0000000000 --- a/docs/ru/md/Instructions/Notion.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: Notion -sidebar_class_name: Notion ---- - - - -# Notion - -Этот раздел посвящен библиотеке для работы с Notion API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -1. Перейдите **[в раздел интеграций портала для разработчиков](https://www.notion.so/my-integrations)** - -![BF](../../static/img/Docs/Notion/1.png) - -2. Введите название вашей интеграции - -![BF](../../static/img/Docs/Notion/2.png) - -3. После завершения создания интеграции, нажмите *Show* и скопируйте **Токен (Secret)** - -![BF](../../static/img/Docs/Notion/3.png) - -4. Перейдите в **[основной интерфейс Notion](https://notion.so)** и создайте новую страницу. Эта страница будет родительской для всех остальных объектов, создаваемых через API - -![BF](../../static/img/Docs/Notion/4.png) - -5. Нажмите три точки в правом верхнем углу и в самом низу найдите пункт *Add connections*. Выберите там свою интеграцию из пунктов 1-3 - -![BF](../../static/img/Docs/Notion/5.png) - -6. Получите ID этой страинцы. Это можно сделать нажав Share -> Copy link или просто скопировав из URL - -![BF](../../static/img/Docs/Notion/6.png) - -**Токен** и **ID страницы** - два параметра, необходимые для работы через API \ No newline at end of file diff --git a/docs/ru/md/Instructions/Slack.md b/docs/ru/md/Instructions/Slack.md deleted file mode 100644 index 308614facb..0000000000 --- a/docs/ru/md/Instructions/Slack.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: Slack -sidebar_class_name: Slack ---- - - - -# Slack - -Этот раздел посвящен библиотеке для работы со Slack Web API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -1. Войдите в свой аккаунт и перейдите на страницу **Your Apps** на сайте [Slack API](https://api.slack.com) - -![BF](../../static/img/Docs/Slack/1.png) - -
- -2. Нажмите **Create App** и выберите пункт **From scratch** - -![BF](../../static/img/Docs/Slack/2.png) - -3. Выберите название и рабочую область, в которой необходимо создать приложение - -![BF](../../static/img/Docs/Slack/3.png) - -
- -4. Создайте новый токен, нажав **Generate Token and Scopes** ниже на странице приложения - -![BF](../../static/img/Docs/Slack/4.png) - -
- -5. Выберите имя и добавьте разрешения - -![BF](../../static/img/Docs/Slack/5.png) - -
- -6. Перейдите в раздел **Premission scope** из пункта установки приложения - -![BF](../../static/img/Docs/Slack/6.png) - -
- -7. Добавьте необходимые для ваших целей разрешения - -![BF](../../static/img/Docs/Slack/7.png) - -
- -8. Установите приложение - -![BF](../../static/img/Docs/Slack/8.png) - -
- -9. Сохраните сгенерированный токен - -![BF](../../static/img/Docs/Slack/9.png) - -
\ No newline at end of file diff --git a/docs/ru/md/Instructions/Start.md b/docs/ru/md/Instructions/Start.md deleted file mode 100644 index 64b083885b..0000000000 --- a/docs/ru/md/Instructions/Start.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: Start -sidebar_class_name: NachaloRaboty ---- - -# Добро пожаловать! - -![OPI](../../static/img/logo_long.png) - -**Открытый пакет интеграций** - набор инструментов для интеграции с некоторыми популярными API посредством CLI, 1C:Enterprise или OneScript. Он состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех. - -Реализованные методы выполняют конечные задачи (вроде *ОтправитьСообщение()* или *СоздатьПост()*), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент. - -
- -Быстрый переход по документации: -
- - - - - - - - - - - - -
- -
- -## Начало работы - -Релизы библиотеки выходят в пяти вариантах: - -- Как CLI приложение для Windows и Linux (exe, rpm, deb) -- Как XML файлы расширения для загрузки через конфигуратор -- Как EDT проект расширения -- Как отдельный файл расширения формата cfe -- Как OneScript пакет расширения ospx - -Вне зависимости от выбранного сопособа установки, получать файлы необходимо из [Release](https://github.com/Bayselonarrend/OpenIntegrations/releases), так как в самих файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки. - -Подробнее о каждом варианте релиза в разделе [Про варианты релизов](/docs/Start/Release-variants) - -
- -## Структура модулей - -Общие модули проекта бывают двух видов: - -- Служебные - - OPI_Инструменты - - OPI_Криптография -- Модули непосредственной работы с API - - OPI_Telegram, OPI_VK... - -:::warning -Не рекомендуется использовать методы служебных модулей в других местах вашей конфигурации (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно. -::: diff --git a/docs/ru/md/Instructions/Telegram.md b/docs/ru/md/Instructions/Telegram.md deleted file mode 100644 index 80edeebb65..0000000000 --- a/docs/ru/md/Instructions/Telegram.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: Telegram -sidebar_class_name: Telegram ---- - - - -# Telegram - -Этот раздел посвящен библиотеке для работы с Telegram API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -- Создайте бота Telegram - - 1. Все действия при работе с Telegram API осуществляются посредством ботов. Для создания нового бота необходимо в мессенджере начать диалог с [@BotFather](https://t.me/BotFather) - - ![BF](../../static/img/Docs/Telegram/2.png) - - 2. Выбрать в меню команду */newbot* - - ![BF](../../static/img/Docs/Telegram/3.png) - - 3. BotFather предложит вам выбрать имя и никнейм бота, после чего процедура создания будет завершена - -- Сохраните **токен**, который вам прислал BotFather после завершения создания бота - - ![BF](../../static/img/Docs/Telegram/1.png) - -- (Дополнительно) Определитесь с целью взаимодействия - - Созданного вами бота теперь можно применить двумя способами - - - В качестве чат-бота - - Для автоматизации ведения канала - - В зависимости от выбранного способа примения будет отличаться способ получения **ID чата** - параметра, отвечающего за определение объекта взаимодействия. - - В случае с чат-ботом, ID чата будет являться ID пользователя, с которым бот осуществляет диалог. Если же бота необходимо использовать для ведения канала, то, после добавления его в качестве администратора, вместо ID чата можно использовать имя канала через @ (@MyChannel) - - Токен и ID чата являются основными параметрами всех методов работы с Telegram API \ No newline at end of file diff --git a/docs/ru/md/Instructions/Twitter.md b/docs/ru/md/Instructions/Twitter.md deleted file mode 100644 index efae7d6b47..0000000000 --- a/docs/ru/md/Instructions/Twitter.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -id: Twitter -sidebar_class_name: Twitter ---- - - - -# Twitter | X - -Этот раздел посвящен библиотеке для работы с Twitter API. На данной странице описаны все действия, необходимые для полноценного начала работы. Данная библиотека позволяет работать с функционалом бесплатного плана, т.е. создавать твиты. - -## Начало работы - - -Работа с Twitter подразумевает работу с двумя API - v1 (1.1) и v2, которые, при этом, не относятся к разным видам действий, но просто являются версиями друг друга. Несмотря на то, что Twitter настаивает на использовании v2, вышло так, что некоторые механизмы (в частности механизм загрузки файлов) в ней так и не появилися. Поэтому, даже для создания обычного твита с картинкой необходима работа с обеими версиями API, а, как следствие, двойной набор авторизационных данны. Этот набор описан в функции *ПолучитьСтандартныеПараметры()* - - -```bsl - - Параметры_.Вставить("redirect_uri" , ""); - Параметры_.Вставить("scope" , ""); - Параметры_.Вставить("client_id" , ""); - Параметры_.Вставить("client_secret" , ""); - Параметры_.Вставить("access_token" , ""); - Параметры_.Вставить("refresh_token" , ""); - Параметры_.Вставить("oauth_token" , ""); - Параметры_.Вставить("oauth_token_secret" , ""); - Параметры_.Вставить("oauth_consumer_key" , ""); - Параметры_.Вставить("oauth_consumer_secret", ""); - -``` - -Вы можете определить эти параметры прямо в структуре внутри данной функции или передавать непосредственно при вызове функций уже для работы с API - каждая из них принимает параметры последним необязательным параметром. При такой передаче стандартные параметры будут перезаписаны по ключам. Рассмотрим создание приложения и получение каждого поля - - - ### Создание приложения - Для работы с Twitter API необходимо перейти по адресу [https://developer.twitter.com/](https://developer.twitter.com/), зарегистрироваться и создать новое приложение - - ![BF](../../static/img/Docs/Twitter/1.png) - ![BF](../../static/img/Docs/Twitter/2.png) - ![BF](../../static/img/Docs/Twitter/3.png) - ![BF](../../static/img/Docs/Twitter/4.png) - ![BF](../../static/img/Docs/Twitter/5.png) - - ### Определение полей - После создания приложения можно заполнить необходимые данные в 1С - - - - **redirect_uri** - - redirect_uri - адрес обработчика http-запросов, указанный при регистрации. Авторизация API v2 требует подтверждения входа через браузер, после которого запрос со специальным кодом на данный обработчик должен будет прийти. Далее об этом будет в пункте access_token и refresh_token. - - - - **scope** - - scope определяет доступные для работы функции. В *ПолучитьСтандартныеПараметры()* список scope определен по умолчанию. - - - **client_id** - - ![BF](../../static/img/Docs/Twitter/6.png) - - - **client_secret** - - ![BF](../../static/img/Docs/Twitter/7.png) - - - **access_token** и **refresh_token** - - Эти токены необходимо получить http запросом с указанием кода, который приходит при авторизации на http-сервис redirect_uri. Порядок действий: - 1. Создать ссылку для авторизации в браузере при помощи функции *ПолучитьСсылкуАвторизации* - 2. Добавить в модуль http-сервиса (GET) вызов функции *ОбработкаВходящегоЗапросаПослеАвторизации*, передавая HTTPСервисЗапрос как параметр. - 3. Авторизоваться в браузере по ссылке из п.1. - 3. Сохранить access_token и refresh_token, полученный из функции *ОбработкаВходящегоЗапросаПослеАвторизации* п. 2, в константы или другое хранилище - - - ```bsl title="Получение" - - Функция Twitterget(Запрос) - - Код = Запрос.ПараметрыЗапроса["code"]; - ОтветТокен = OPI_Twitter.ПолучитьТокен(Код, Параметры); - - Константы.TwitterRefresh.Установить(ОтветТокен["refresh_token"]); - Константы.TwitterToken.Установить(ОтветТокен["access_token"]); - - Ответ = Новый HTTPСервисОтвет(200); - Возврат Ответ; - - КонецФункции - - ``` - - ```bsl title="Обновление" - - Процедура ОбновлятьТокенКаждыеДваЧаса(Знач Параметры) - - Ответ = OPI_Twitter.ОбновитьТокен(Параметры); - Константы.TwitterToken.Установить(Ответ["access_token"]); - Константы.TwitterRefresh.Установить(Ответ["refresh_token"]); - - КонецПроцедуры - ``` - - Хардкодить данные токены нельзя, так как acess_token действует всего 2 часа. По истечении этого времени, токен необходимо обновить функцией *ОбновитьТокен*. При этом обновляется как access_token, так и refresh_token. Т.е. при следующем обновлении сгоревшего acess_token токена, refresh_token должен быть из предыдущего запроса. - - ![BF](../../static/img/Docs/Twitter/8.png) - - - - **oauth_token** и **oauth_token_secret** - - ![BF](../../static/img/Docs/Twitter/9.png) - - - **oauth_consumer_key** и **oauth_consumer_secret** - - ![BF](../../static/img/Docs/Twitter/10.png) - - - После заполнения данных полей можно приступать к работе с методами API - - - \ No newline at end of file diff --git a/docs/ru/md/Instructions/VK.md b/docs/ru/md/Instructions/VK.md deleted file mode 100644 index f39029adb5..0000000000 --- a/docs/ru/md/Instructions/VK.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: VK -sidebar_class_name: VK ---- - - - -# ВКонтакте - -Этот раздел посвящен библиотеке для работы с VK API. Она заточена для работы с сообществами и выполнением действий от их имени. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -Для начала работы необходимо получить некоторые параметры для VK API. - -

-Перечень необходимых данных в виде структуры содержится в функции *ПолучитьСтандартныеПараметры()*. Вы можете указывать значения параметров прямо в ней или же передавать их структурой при вызове любых других методов библиотеки в качестве необязательного параметра *Параметры* (последний во всех методах билиотеки). В последнем случае стандартные параметры будут перезаписаны по ключам теми, которые переданы при вызове метода. Перезаписаны будут только совпадающие по ключам данные. Если какой то параметр есть в наборе стандартных, но не был передан при вызове метода, то он сохранит стандартное значение. -

- - ```bsl - _Параметры = Новый Структура; - - _Параметры.Вставить("v" , "5.131"); - _Параметры.Вставить("from_group" , "1"); - _Параметры.Вставить("group_id" , "123456789"); - _Параметры.Вставить("owner_id" , "-123456789"); - _Параметры.Вставить("app_id" , "87654321"); - _Параметры.Вставить("access_token" , "vk1.a.E-byuFeG1qcN7..."); - - ``` - -Рассмотрим получение каждого значения: - -**1. v** - - Параметр `v` означает версию VK API. Тестирование проводилось на 5.131, рекомендуется его таким и оставить - -**2. from_group** - - От лица группы. Должен быть 1 - -**3. group_id и owner_id** - - ID группы. Если у вас стандартный адрес группы, то id можно найти в URL. В противном случае он будет на вкладке "Управление" в группе, под полем Адрес. owner_id - тоже самое, но со знаком '-' впереди - - ![BF](../../static/img/Docs/VK/1.png) - -**4. app_id** - - app_id - ID приложения. Для создания приложения необходимо: - - * Перейти по адресу https://id.vk.com/about/business/go, авторизоваться и ввести свои данные физ. или юр. лица - - ![BF](../../static/img/Docs/VK/2.png) - - * Ввести название приложения и выбрать пункт **Web** - - ![BF](../../static/img/Docs/VK/3.png) - - * Ввести домееное имя и URL обработчика перенаправлений. Тут нужно отметить, что данный механизм создания приложений - новый. Еще недавно приложения VK создавались иначе и иметь redirect_url для них было не нужно. На данный момент не совсем понятно, зачем он нужен нам для серверного приложения - просто такого понятия как серверное приложение у VK теперь нет. Теоретически, туда можно вписать что угодно - для работы с библиотекой в получении обратных данных нет необходимости. Однако, с течением времени, это может измениться. - - ![BF](../../static/img/Docs/VK/4.png) - - * Ввести паспортные данные или данные об организации, включить доступ к сообществам (короче, если у вас уже было приложение до этого, то вам крупно повезло, а если нет российского паспорта - придется писать в поддержку) - - ![BF](../../static/img/Docs/VK/8.png) - - * Получить app_id на странице приложения - - ![BF](../../static/img/Docs/VK/5.png) - -**5. access_token** - - Ссылку на получение acess_token можно получить при помощи функции *СоздатьСсылкуПолученияТокена* или склеить вручную: - - https://oauth.vk.com/authorize?client_id= + *app_id* + &scope=offline,wall,groups,photos,stats,stories,ads&v=5.131&response_type=token&redirect_uri=https://api.vk.com/blank.html - - * По этой ссылке необходимо перейти в браузере - * Авторизоваться через ВК и подтвердить доступ - * Забрать токен из параметра URL в адресной строке - - ![BF](../../static/img/Docs/VK/6.png) - -**(Дополнительно) communitytoken** - - Некоторые методы, например для работы с чат-ботом сообщества, принимают в качестве параметра communitytoken - в этих методах он заменяет access_token. Для его получения необходимо: - - * Зайти в раздел "Управление" в группе ВК - * Найти вкладку "Работа с API" - * Нажать "Создать ключ" и забрать его - - ![BF](../../static/img/Docs/VK/7.png) - - Пока вам не нужно использовать такие методы, получать communitytoken не обязательно \ No newline at end of file diff --git a/docs/ru/md/Instructions/Viber.md b/docs/ru/md/Instructions/Viber.md deleted file mode 100644 index 2f9bd2008c..0000000000 --- a/docs/ru/md/Instructions/Viber.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: Viber -sidebar_class_name: Viber ---- - - - -# Viber - -Этот раздел посвящен библиотеке для работы с Viber API. На данной странице описаны все действия, необходимые для полноценного начала работы - -:::warning -Начиная с 05.02.2024 данный способ создания ботов более недействителен: Rakuten отменил возможность создавать ботов бесплатно и теперь для работы с API необходимо проходить верификацию по коммерческой модели. Подробнее [тут](https://help.viber.com/hc/en-us/articles/15247629658525-Bot-commercial-model) -::: - -## Начало работы - -У Viber есть два REST API: один для работы с каналами, а второй - для чат-ботов. В обоих случаях основными параметрами служат **Токен** и **IDПользователя** - -- Если вам необходимо управлять каналом: - 1. Зайдите в приложение Viber и создайте новый канал - - ![BF](../../static/img/Docs/Viber/1.png) - - 2. После создания, перейдите в настройки канала -> Для разработчиков, и скопируйте **Токен** - - ![BF](../../static/img/Docs/Viber/2.png) - - 3. Установите Webhook. См. Установить Webhook - 4. **IDПользователя** - ваш ID (администратора канала). См. Получить информацию о канале - -
- -- Если вам необходим чат-бот: - 1. Перейдите по ссылке [https://partners.viber.com/account/create-bot-account](https://partners.viber.com/account/create-bot-account) и авторизуйтесь с вашим номером телефона, который привязан к Viber - - ![BF](../../static/img/Docs/Viber/3.png) - - 2. Выберите пункт создания нового бота - - ![BF](../../static/img/Docs/Viber/4.png) - - 3. В меню создания бота заполните все необходимые поля - - ![BF](../../static/img/Docs/Viber/5.png) - - 4. Скопируйте **Токен** - - ![BF](../../static/img/Docs/Viber/6.png) - - 4. Найти своего нового бота вы можете отсканировав QR на странице создания или в настройках (пункт чат-боты) в приложении Viber. - - ![BF](../../static/img/Docs/Viber/7.png) - - 5. Сейчас вы не можете начать диалог с ботом, сначала необходимо установить Webhook. См. Установить Webhook - 6. После запуска **IDПользователя** будет ID конкретного человека, ведущего диалог с ботом. Получить можно из обработыки входящих сообщения по Webhook - - - **Важно:** ID одного и того же пользователя у чата и канала - это разные значения. Нельзя использовать ID, полученный из сообщения боту для вызова методов управления каналом и наоборот \ No newline at end of file diff --git a/docs/ru/md/Instructions/Yandex_Disk.md b/docs/ru/md/Instructions/Yandex_Disk.md deleted file mode 100644 index 8934261fe0..0000000000 --- a/docs/ru/md/Instructions/Yandex_Disk.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: YandexDisk -sidebar_class_name: YandexDisk ---- - - - -# Яндекс Диск - -Этот раздел посвящен библиотеке для работы с Яндекс Диск API. На данной странице описаны все действия, необходимые для полноценного начала работы - -## Начало работы - -Для начала работы необходимо получить токен доступа к диску: - -1. Перейдите на [страницу создания приложения](https://oauth.yandex.ru/client/new/) - -![BF](../../static/img/Docs/YandexDisk/1.png) - -2. Введите название сервиса, выберите *Веб-сервисы* в качестве платформы. Redirect URI можно указать любой или выбрать пункт *Подставить URL для отладки* - для работы с библиотекой он не понадобится. - -![BF](../../static/img/Docs/YandexDisk/3.png) - -3. В поле *Доступ к данным* добавьте разрешения как на скриншоте ниже, после чего нажмите *Создать приложение* - -![BF](../../static/img/Docs/YandexDisk/2.png) - -4. Сохраните **ClientID** и **Client secret** со страницы приложения - -![BF](../../static/img/Docs/YandexDisk/4.png) - -5. Вызовите функцию *OPI_YandexID.ПолучитьКодПодтверждения()*, передав ClientID в качестве параметра. Она вернет ответ сервера Yandex, где будут поля: - - **user_code** - необходимо будет ввести в браузере - - **device_code** - необходимо будет передать в другую функцию - - **verification_url** - URL, который нужно открыть в браузере -
- ```json title="Результат функции ПолучитьКодПодтверждения(), если перевести его в JSON" - { - "verification_url": "https://ya.ru/device", - "user_code": "gjehyruw", - "interval": 5, - "expires_in": 300, - "device_code": "12207cafec1b40ad8d0052af3faf0d12" - } - ``` - -6. Откройте URL из **verification_url** в барузере. Скорее всего это будет https://ya.ru/device. В появившееся поле введите **user_code** из пункта 5 - -![BF](../../static/img/Docs/YandexDisk/5.png) - -7. После ввода кода в пункте 6, вызовите функцию *OPI_YandexID.ПреобразоватьКодВТокен()*, передав туда **ClientID** и **ClientSecret** из пункта 4, а также **device_code** из пункта 5. Сохраните полученные **acess_token** и **refresh_token** - -```json title="Результат функции ПреобразоватьКодВТокен(), если перевести его в JSON" -{ - "token_type": "bearer", - "refresh_token": "1:Tj6nD2vgE2L8jwSm:YgWjQXPv6_y3e07GW70ig2AOyEXoRVsKKpApGHq2EOg7pfx0MKrXiCrfLBFtzgQawdawdwadad3Sasa9z2H0vSeZKNmZmA", - "expires_in": 31535956, - "access_token": "y0_AgAAAABWxxdkAAs0QgAAAAD59cawdawdwadadVKIiwGK__crw" -} -``` - -**acess_token** используется во всех остальных функциях библиотеки, а при помощи **refresh_token** его можно обновить, когда срок жизни будет подходить к концу (при помощи функции *ОбновитьТокен()*) \ No newline at end of file diff --git a/docs/ru/md/Start/CLI_version.md b/docs/ru/md/Start/CLI_version.md deleted file mode 100644 index b63125b847..0000000000 --- a/docs/ru/md/Start/CLI_version.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Работа с CLI версией - -**OInt CLI** - приложение для командой строки, которое позволяет использовать методы Открытого пакета интеграций независимо от 1С и OneScript. Для его работы требуется **.Net Framework 4.8** или сопоставимый **Mono Runtime** (при использовании deb и rpm пакетов устанавливается автоматически) - -## Первый запуск - -Для начала работы необходимо вызвать команду `oint` из командной строки/терминала. При установке из пакетов (Linux) или установщика (Windows, после перезагрузки), сделать это можно из любого места без дополнительных действий. При использовании портативной версии (исполняемого файла exe) `oint` необходимо запускать по полному пути к файлу. В Linux-дистрибутивах, также, предварительно нужно будет прописать `chmod +x <путь к файлу>/oint` - -Запуск портативной версии в RHEL/Fedora/CentOS (дистрибутивы, использующие rpm-пакеты) осуществляется командой
`mono <путь к файлу>/oint "$@"` - -![demo](./img/1.gif) - -## Справка - -После запуска приложения, вы увидите начальную страницу, где есть перечень доступных библиотек. Для того, чтобы просмотреть список доступных методов конкретной библиотеки, необходимо просто написать `oint` и её название. Например `oint telegram`. Аналогично можно узнать подробности о конкретном методе - необходимо вызвать команду `oint <библиотека> <метод>`, например `oint telegram ОтправитьТекстовоеСообщение` - ->**Важно:** Имена библиотек чувствительны к регистру и пишутся строчными буквами. Имена методов к регистру не чувствительны - -![demo](./img/3.gif) - -## Использование методов -Как и большинство других программ, нацеленных на использование в bat/sh скриптах, каждое отдельное действие Oint CLI вызывается полной строкой вызова следующего вида: - -```powershell - oint <библиотека> <метод> --парам1 "Значение" --парам2 "Значение"... -``` - -Что касается параметров, то чаще всего передаваемые туда данные - строки. Это может быть текст, пути к файлам, URL и пр. Однако, в OInt есть методы, которые принимают и другие, менее очевидные виды данных. Это могут быть: - - + Даты - передаются как строки формата ISO 8601 - + Массивы - передаются как строки вида `"['Знач1','Знач2','Знач3']"` - + JSON - передается как путь к файлу - -После выполнения запрашиваемого действия, программа выводит результат и завершает работу. По умолчанию, вывод осуществляется в консоль, но вы можете перенаправить его в файл - как стандартным способом `>`, так и при помощи общего параметра `--out`. Разница между двумя этими способами заключается в кодировке сохраняемого файла: при использовании `>` это будет кодировка оболочки, а при использованни `--out` - UTF-8 (используется внутри OInt при работе). Также использование `--out` обязательно для методов, возвращающих двоичные данные в ответе (вроде скачивания файла из Google Drive, например) - -![demo](./img/2.gif) - -Всю дальнейшую информацию, которая может понадобиться вам для работы, вы сможете найти в других разделах данной документации, а также во встроенной справке OInt CLI diff --git a/docs/ru/md/Start/Release-variants.md b/docs/ru/md/Start/Release-variants.md deleted file mode 100644 index 088087aede..0000000000 --- a/docs/ru/md/Start/Release-variants.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Про варианты релизов - -Открытый пакет интеграций - это проект с тремя путями развития: 1С, OneScript и CLI. Основная версия - 1С, которая далее автоматически трансформируется в пакет для OneScript, а из него - в CLI приложение. Каждый из этих путей имеет свои варианты распространения - всего их 8: 3 для 1С, 4 для CLI и 1 для OneScript. Здесь приведены описания каждого из них - ->Ссылка на последний релиз: [Тык!](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest) - -## 1С:Enterprise -Данные варианты релизов - различные формы поставки расширения для платформы 1С:Предприятие - - -**OpenIntegrations_x.x.x.cfe** - стандартный вариант поставки расширения конфигурации 1С:Предприятие. Для начала работы достаточно загрузить его в список расширений вашей конкретной конфигурации. Разработка ведется в режиме совместимости 1С 8.3.9 - - -**XML.zip** - это zip-архив, который содержит в себе файлы стандартной выгрузки расширения 1С "в файлы". Аналогично варианту с CFE, распакованный архив можно использовать для загрузки расширения через панель Расширений конфигурации в конкретном проекте - - -**EDT.zip** - это zip-архив, который содержит в себе файлы проекта расширения EDT. Этот вариант поставки предназначен для быстрого старта работы с ОПИ в тех случаях, когда разработка основной конфигурации ведется с использованием 1C Enterprise Development Tools - -
- -## CLI -Данные варианты релизов - различные формы поставки OInt CLI - кросплатформенного приложения для терминала/командной строки, реализующего полный функционал библиотеки ОПИ без привязки к тех. стеку 1С/OS. Системные требования OInt - системные требования OneScript: **.Net Framework 4.8 (Windows)** или **сопоставимая версия Mono (Linux)** - - -**oint.exe** - исполняемый файл, который, несмотря на Windows-ориентированное расширение, является кросплатформенным. Для запуска требуется .Net Framework 4.8 или Mono совместимой версии. В Windows и Debian-based дистрибутивах данное приложение запускается просто через командную строку/терминал, а в дистрибутивах, основанных на RHEL - через ```mono oint.exe "$@"``` - - -**oint_x.x.x_installer.exe** - это Windows-установщик. Рекомендуемый способ установки для ОС Windows, так как при его использовании автоматически создается каталог программы и прописывается PATH (после презагрузки компьютера). Это позволяет в дальнейшем запускать приложение из любого места, просто написав `oint` в командной строке - - -**oint_x.x.x_all.deb** - это DEB-пакет, предназанченный для установки OInt в Debian/Ubuntu дистрибутивах. При его использовании зависимости Mono устанавливаются автоматически, следовательно никаких дополнительных действий для начала работы не требуется - - -**oint-x.x.x-1.el7.x86_64.rpm** - это RPM-пакет, предназанченный для установки OInt в RHEL/Fedora/CentOS дистрибутивах. При его использовании зависимости Mono устанавливаются автоматически, следовательно никаких дополнительных действий для начала работы не требуется. Также не требуется запуск через `mono`, как в случае с exe - -
- - -## OneScript -Данные варианты релизов предназначены для использования в OneScript-проектах - - -**oint-x.x.x.ospx** - это OSPX пакет, предназначенный для установки через пакетный менеджер OPM. Вы можете использовать его для оффлайн установки при помощи команды -``` opm install -f "./OInt-x.x.x.ospx" ```. -Если отсутствие интернета на машине не предполагается, гораздо проще установить OInt напрямую из хаба пакетов. Скачивания файла для этого не требуется, достаточно выполнить команду ``` opm install oint ``` - - - -
\ No newline at end of file diff --git a/docs/ru/md/Start/img/1.gif b/docs/ru/md/Start/img/1.gif deleted file mode 100644 index ca5af98bde..0000000000 Binary files a/docs/ru/md/Start/img/1.gif and /dev/null differ diff --git a/docs/ru/md/Start/img/1.png b/docs/ru/md/Start/img/1.png deleted file mode 100644 index 0ef333028e..0000000000 Binary files a/docs/ru/md/Start/img/1.png and /dev/null differ diff --git a/docs/ru/md/Start/img/2.gif b/docs/ru/md/Start/img/2.gif deleted file mode 100644 index 1531d076cc..0000000000 Binary files a/docs/ru/md/Start/img/2.gif and /dev/null differ diff --git a/docs/ru/md/Start/img/2.png b/docs/ru/md/Start/img/2.png deleted file mode 100644 index fb36e9d643..0000000000 Binary files a/docs/ru/md/Start/img/2.png and /dev/null differ diff --git a/docs/ru/md/Start/img/3.gif b/docs/ru/md/Start/img/3.gif deleted file mode 100644 index 12d043fd36..0000000000 Binary files a/docs/ru/md/Start/img/3.gif and /dev/null differ diff --git a/docs/ru/md/Start/img/3.png b/docs/ru/md/Start/img/3.png deleted file mode 100644 index e61645a9d4..0000000000 Binary files a/docs/ru/md/Start/img/3.png and /dev/null differ diff --git a/docs/ru/md/Start/img/4.png b/docs/ru/md/Start/img/4.png deleted file mode 100644 index 7b74f244a6..0000000000 Binary files a/docs/ru/md/Start/img/4.png and /dev/null differ diff --git a/docs/ru/md/Start/img/5.png b/docs/ru/md/Start/img/5.png deleted file mode 100644 index 950f0e6391..0000000000 Binary files a/docs/ru/md/Start/img/5.png and /dev/null differ diff --git a/docs/ru/md/Start/img/6.png b/docs/ru/md/Start/img/6.png deleted file mode 100644 index 0f0f7f8510..0000000000 Binary files a/docs/ru/md/Start/img/6.png and /dev/null differ diff --git a/docs/ru/md/Start/img/7.png b/docs/ru/md/Start/img/7.png deleted file mode 100644 index 83ad223f15..0000000000 Binary files a/docs/ru/md/Start/img/7.png and /dev/null differ diff --git a/docs/ru/md/Start/img/8.png b/docs/ru/md/Start/img/8.png deleted file mode 100644 index 0cfcdef647..0000000000 Binary files a/docs/ru/md/Start/img/8.png and /dev/null differ diff --git a/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md b/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md deleted file mode 100644 index f92d10d8eb..0000000000 --- a/docs/ru/md/VK/Ad-account-management/Pause-advertising-ad.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Приостановить рекламное объявление - Приостанавливает показ рекламного объявления - - -*Функция ПриостановитьРекламноеОбъявление(Знач IDКабинета, Знач IDОбъявления, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | IDКабинета | --cabinet | Строка,Число | ID рекламного кабинета | - | IDОбъявления | --adv | Строка,Число | ID объявления | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ПриостановитьРекламноеОбъявление(1234567890, 1029701085, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - -``` - -```sh title="Пример команды CLI" - - oint vk ПриостановитьРекламноеОбъявление --cabinet %cabinet% --adv %adv% --auth %auth% - -``` - - -```json title="Результат" - -{ - "response": [ - { - "id": 1029701085 - } - ] - } - -``` diff --git a/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md b/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md deleted file mode 100644 index f4f191ea01..0000000000 --- a/docs/ru/md/VK/Product-selection-management/Add-product-to-selection.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Добавить товар в подборку - Добавляет товар в подборку - - -*Функция ДобавитьТоварВПодборку(Знач МассивТоваров, Знач Подборка, Знач Параметры = "") Экспорт* - - | Параметр | CLI опция | Тип | Назначение | - |-|-|-|-| - | МассивТоваров | --items | Массив из Строка, Число | Массив товаров или товар | - | Подборка | --sel | Строка | ID подборки | - | Параметры | --auth | Структура из Строка | JSON авторизации или путь к .json | - - - Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от VK - -```bsl title="Пример кода" - - - Ответ = OPI_VK.ДобавитьТоварВПодборку(8656559, 40, Параметры); - Ответ = OPI_Инструменты.JSONСтрокой(Ответ); - - -``` - -```sh title="Пример команды CLI" - - oint vk ДобавитьТоварВПодборку --items %items% --sel %sel% --auth %auth% - -``` - - -```json title="Результат" - -{ - "response": 1 - } - -``` diff --git a/service/dictionaries/en.json b/service/dictionaries/en.json index 3f66808af8..b2474d34fa 100644 --- a/service/dictionaries/en.json +++ b/service/dictionaries/en.json @@ -5042,5 +5042,10 @@ "Работа с 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", +"Это сообщение было удалено": "This message was deleted", +"Записал":"Write it!", +"Не спланированы":"Not planned", +"Сделаю на неделе":"For this week", +"Сохранить":"Save" } diff --git a/src/en/OInt/packagedef b/src/en/OInt/packagedef index 67e44e2df2..e3e8429e0d 100644 --- a/src/en/OInt/packagedef +++ b/src/en/OInt/packagedef @@ -1,4 +1,4 @@ -Описание.Имя("oint") +Описание.Имя("oint") .Версия("1.11.0") .Автор("bayselonarrend") .АдресАвтора("bayselonarrend@gmail.com") diff --git a/src/en/OPI/DT-INF/PROJECT.PMF b/src/en/OPI/DT-INF/PROJECT.PMF index d72af02b06..0839fe3b17 100644 --- a/src/en/OPI/DT-INF/PROJECT.PMF +++ b/src/en/OPI/DT-INF/PROJECT.PMF @@ -1,3 +1,4 @@ Manifest-Version: 1.0 Runtime-Version: 8.3.15 -Base-Project: OpenIntegrations_ENG +Base-Project: OpenIntegrations_Eng +Manifest-Version: 1.0 diff --git a/src/ru/OInt/lib.config b/src/ru/OInt/lib.config index 92fd8c06d7..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/Configuration/Configuration.mdo b/src/ru/OPI/src/Configuration/Configuration.mdo index bec018c96d..8f917a17b7 100644 --- a/src/ru/OPI/src/Configuration/Configuration.mdo +++ b/src/ru/OPI/src/Configuration/Configuration.mdo @@ -57,7 +57,6 @@ CommonModule.OPI_Slack CommonModule.OPI_Airtable CommonModule.OPI_Dropbox - CommonModule.OPI_Bitrix24 CommonModule.OPI_Тесты CommonModule.OPI_ПолучениеДанныхТестов