1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-19 21:17:55 +02:00
Code Issues Releases Activity

Создание MD файлов документации

Browse Source
This commit is contained in:
Vitaly the Alpaca 2024-08-13 10:24:12 +00:00 committed by Vitaly the Alpaca (bot)
parent ff8d96df2a
commit 27cc9e3d02
266 changed files with 22116 additions and 22138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

166
docs/en/md/Bitrix24/Catalogs-managment/Create-subfolder.md
View File

@ -1,83 +1,83 @@
---
sidebar_position: 2
---
# Create new subfolder
Create new folder inside another folder
`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Parent folder identifier |
| Name | --title | String | Name of new folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php)
:::
<br/>
```bsl title="Code example"
FolderID = "5016";
Name = "New subfolder";
Filename2 = "New subfolder 2";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateSubfolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 850,
"NAME": "New subfolder",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": 850,
"PARENT_ID": "846",
"DELETED_TYPE": 0,
"CREATE_TIME": "2024-06-27T07:19:57+00:00",
"UPDATE_TIME": "2024-06-27T07:19:57+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
},
"time": {
"start": 1719472797.42827,
"finish": 1719472797.50854,
"duration": 0.080265998840332,
"processing": 0.0455958843231201,
"date_start": "2024-06-27T07:19:57+00:00",
"date_finish": "2024-06-27T07:19:57+00:00",
"operating_reset_at": 1719473397,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Create new subfolder
Create new folder inside another folder
`Function CreateSubfolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Parent folder identifier |
| Name | --title | String | Name of new folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_addsubfolder.php)
:::
<br/>
```bsl title="Code example"
FolderID = "5016";
Name = "New subfolder";
Filename2 = "New subfolder 2";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Filename2);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateSubfolder(URL, FolderID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateSubfolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 850,
"NAME": "New subfolder",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": 850,
"PARENT_ID": "846",
"DELETED_TYPE": 0,
"CREATE_TIME": "2024-06-27T07:19:57+00:00",
"UPDATE_TIME": "2024-06-27T07:19:57+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
},
"time": {
"start": 1719472797.42827,
"finish": 1719472797.50854,
"duration": 0.080265998840332,
"processing": 0.0455958843231201,
"date_start": "2024-06-27T07:19:57+00:00",
"date_finish": "2024-06-27T07:19:57+00:00",
"operating_reset_at": 1719473397,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Catalogs-managment/Delete-folder.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 5
---
# Delete folder
Remove folder with subfolders
`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | ID of folder to be deleted |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5014";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FolderID = "5016";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1719047257.50616,
"finish": 1719047257.55445,
"duration": 0.048285961151123,
"processing": 0.0174880027770996,
"date_start": "2024-06-22T09:07:37+00:00",
"date_finish": "2024-06-22T09:07:37+00:00",
"operating_reset_at": 1719047857,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Delete folder
Remove folder with subfolders
`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | ID of folder to be deleted |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_deletetree.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5014";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FolderID = "5016";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1719047257.50616,
"finish": 1719047257.55445,
"duration": 0.048285961151123,
"processing": 0.0174880027770996,
"date_start": "2024-06-22T09:07:37+00:00",
"date_finish": "2024-06-22T09:07:37+00:00",
"operating_reset_at": 1719047857,
"operating": 0
}
}
```

126
docs/en/md/Bitrix24/Catalogs-managment/Get-folder-external-link.md
View File

@ -1,63 +1,63 @@
---
sidebar_position: 6
---
# Get external link for folder
Get external link to folder
`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderExternalLink --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "https://b24-ar17wx.bitrix24.by/~hWalI",
"time": {
"start": 1719472796.12325,
"finish": 1719472796.16843,
"duration": 0.0451798439025879,
"processing": 0.0110611915588379,
"date_start": "2024-06-27T07:19:56+00:00",
"date_finish": "2024-06-27T07:19:56+00:00",
"operating_reset_at": 1719473396,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Get external link for folder
Get external link to folder
`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getexternallink.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderExternalLink --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "https://b24-ar17wx.bitrix24.by/~hWalI",
"time": {
"start": 1719472796.12325,
"finish": 1719472796.16843,
"duration": 0.0451798439025879,
"processing": 0.0110611915588379,
"date_start": "2024-06-27T07:19:56+00:00",
"date_finish": "2024-06-27T07:19:56+00:00",
"operating_reset_at": 1719473396,
"operating": 0
}
}
```

122
docs/en/md/Bitrix24/Catalogs-managment/Get-folder-filter-structure.md
View File

@ -1,61 +1,61 @@
---
sidebar_position: 11
---
# Get fields structure for folder items filter
Returns filter structure for child folder items
`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
| Token | --token | String | Access token, when app auth method used |
Returns: Structure of KeyAndValue - Fields structure
<br/>
:::tip
Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetFolderFilterStructure(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderFilterStructure --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"ID": "",
"NAME": "",
"TYPE": "",
"CODE": "",
"STORAGE_ID": "",
"PARENT_ID": "",
"CREATE_TIME": "",
"UPDATE_TIME": "",
"DELETE_TIME": "",
"DELETED_TYPE": ""
}
```
---
sidebar_position: 11
---
# Get fields structure for folder items filter
Returns filter structure for child folder items
`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
| Token | --token | String | Access token, when app auth method used |
Returns: Structure of KeyAndValue - Fields structure
<br/>
:::tip
Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getfields.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetFolderFilterStructure(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderFilterStructure --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"ID": "",
"NAME": "",
"TYPE": "",
"CODE": "",
"STORAGE_ID": "",
"PARENT_ID": "",
"CREATE_TIME": "",
"UPDATE_TIME": "",
"DELETE_TIME": "",
"DELETED_TYPE": ""
}
```

158
docs/en/md/Bitrix24/Catalogs-managment/Get-folder-information.md
View File

@ -1,79 +1,79 @@
---
sidebar_position: 1
---
# Get information about folder
Get folder information
`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderInformation --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1722",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "1722",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-03T14:42:37+00:00",
"UPDATE_TIME": "2024-07-03T14:42:37+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1720017760.63451,
"finish": 1720017760.68628,
"duration": 0.0517730712890625,
"processing": 0.0117180347442627,
"date_start": "2024-07-03T14:42:40+00:00",
"date_finish": "2024-07-03T14:42:40+00:00",
"operating_reset_at": 1720018360,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Get information about folder
Get folder information
`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderInformation --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1722",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "1722",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-03T14:42:37+00:00",
"UPDATE_TIME": "2024-07-03T14:42:37+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1720017760.63451,
"finish": 1720017760.68628,
"duration": 0.0517730712890625,
"processing": 0.0117180347442627,
"date_start": "2024-07-03T14:42:40+00:00",
"date_finish": "2024-07-03T14:42:40+00:00",
"operating_reset_at": 1720018360,
"operating": 0
}
}
```

200
docs/en/md/Bitrix24/Catalogs-managment/Get-folder-items.md
View File

@ -1,100 +1,100 @@
---
sidebar_position: 7
---
# Get folder child elements
Get folder child elements
`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID,, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderItems --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "848",
"NAME": "New subfolder 2",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "848",
"PARENT_ID": "846",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-06-27T07:19:56+00:00",
"UPDATE_TIME": "2024-06-27T07:19:58+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2"
},
{
"ID": "850",
"NAME": "New subfolder",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "850",
"PARENT_ID": "846",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-06-27T07:19:57+00:00",
"UPDATE_TIME": "2024-06-27T07:19:58+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
}
],
"total": 2,
"time": {
"start": 1719472801.3139,
"finish": 1719472801.36215,
"duration": 0.0482509136199951,
"processing": 0.0148689746856689,
"date_start": "2024-06-27T07:20:01+00:00",
"date_finish": "2024-06-27T07:20:01+00:00",
"operating_reset_at": 1719473401,
"operating": 0
}
}
```
---
sidebar_position: 7
---
# Get folder child elements
Get folder child elements
`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Filter | --filter | Structure of KeyAndValue | Items filter (see GetFolderFilterStructure) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_getchildren.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID,, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderItems --url "b24-ar17wx.bitrix24.by" --folderid "2490" --filter %filter% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "848",
"NAME": "New subfolder 2",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "848",
"PARENT_ID": "846",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-06-27T07:19:56+00:00",
"UPDATE_TIME": "2024-06-27T07:19:58+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder 2"
},
{
"ID": "850",
"NAME": "New subfolder",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "850",
"PARENT_ID": "846",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-06-27T07:19:57+00:00",
"UPDATE_TIME": "2024-06-27T07:19:58+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder"
}
],
"total": 2,
"time": {
"start": 1719472801.3139,
"finish": 1719472801.36215,
"duration": 0.0482509136199951,
"processing": 0.0148689746856689,
"date_start": "2024-06-27T07:20:01+00:00",
"date_finish": "2024-06-27T07:20:01+00:00",
"operating_reset_at": 1719473401,
"operating": 0
}
}
```

174
docs/en/md/Bitrix24/Catalogs-managment/Make-folder-copy.md
View File

@ -1,87 +1,87 @@
---
sidebar_position: 3
---
# Copy folder
Copy one folder to another
`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| DestinationID | --tagetid | String, Number | ID of target folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php)
:::
<br/>
```bsl title="Code example"
DestinationID = "5018";
FolderID = "5020";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID);
DestinationID = "5020";
FolderID = "5018";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MakeFolderCopy --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 1732,
"NAME": "New subfolder 2",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": 1732,
"PARENT_ID": "1726",
"DELETED_TYPE": 0,
"CREATE_TIME": "2024-07-03T14:42:46+00:00",
"UPDATE_TIME": "2024-07-03T14:42:46+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2"
},
"time": {
"start": 1720017765.97028,
"finish": 1720017766.08005,
"duration": 0.109767913818359,
"processing": 0.0799601078033447,
"date_start": "2024-07-03T14:42:45+00:00",
"date_finish": "2024-07-03T14:42:46+00:00",
"operating_reset_at": 1720018366,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Copy folder
Copy one folder to another
`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| DestinationID | --tagetid | String, Number | ID of target folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_copyto.php)
:::
<br/>
```bsl title="Code example"
DestinationID = "5018";
FolderID = "5020";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID);
DestinationID = "5020";
FolderID = "5018";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MakeFolderCopy --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2494" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 1732,
"NAME": "New subfolder 2",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": 1732,
"PARENT_ID": "1726",
"DELETED_TYPE": 0,
"CREATE_TIME": "2024-07-03T14:42:46+00:00",
"UPDATE_TIME": "2024-07-03T14:42:46+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog/New subfolder/New subfolder 2"
},
"time": {
"start": 1720017765.97028,
"finish": 1720017766.08005,
"duration": 0.109767913818359,
"processing": 0.0799601078033447,
"date_start": "2024-07-03T14:42:45+00:00",
"date_finish": "2024-07-03T14:42:46+00:00",
"operating_reset_at": 1720018366,
"operating": 0
}
}
```

158
docs/en/md/Bitrix24/Catalogs-managment/Mark-folder-as-deleted.md
View File

@ -1,79 +1,79 @@
---
sidebar_position: 8
---
# Mark folder as deleted
Move folder to recycle bin
`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkFolderAsDeleted --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "936",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "936",
"PARENT_ID": "3",
"DELETED_TYPE": "3",
"CREATE_TIME": "2024-07-01T13:44:01+00:00",
"UPDATE_TIME": "2024-07-01T13:44:06+00:00",
"DELETE_TIME": "2024-07-01T13:44:12+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719841453.13782,
"finish": 1719841453.17717,
"duration": 0.0393478870391846,
"processing": 0.00959300994873047,
"date_start": "2024-07-01T13:44:13+00:00",
"date_finish": "2024-07-01T13:44:13+00:00",
"operating_reset_at": 1719842053,
"operating": 0
}
}
```
---
sidebar_position: 8
---
# Mark folder as deleted
Move folder to recycle bin
`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_markdeleted.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkFolderAsDeleted --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "936",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "936",
"PARENT_ID": "3",
"DELETED_TYPE": "3",
"CREATE_TIME": "2024-07-01T13:44:01+00:00",
"UPDATE_TIME": "2024-07-01T13:44:06+00:00",
"DELETE_TIME": "2024-07-01T13:44:12+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719841453.13782,
"finish": 1719841453.17717,
"duration": 0.0393478870391846,
"processing": 0.00959300994873047,
"date_start": "2024-07-01T13:44:13+00:00",
"date_finish": "2024-07-01T13:44:13+00:00",
"operating_reset_at": 1719842053,
"operating": 0
}
}
```

172
docs/en/md/Bitrix24/Catalogs-managment/Move-folder.md
View File

@ -1,86 +1,86 @@
---
sidebar_position: 4
---
# Move folder
Moves one folder inside another
`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| DestinationID | --tagetid | String, Number | ID of target folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php)
:::
<br/>
```bsl title="Code example"
DestinationID = "5014";
FolderID = "5020";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID);
FolderID = "5018";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MoveFolder --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "938",
"NAME": "New subfolder 2",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "938",
"PARENT_ID": 934,
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-01T13:44:06+00:00",
"UPDATE_TIME": "2024-07-01T13:44:07+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2"
},
"time": {
"start": 1719841451.89089,
"finish": 1719841451.95846,
"duration": 0.0675740242004394,
"processing": 0.0360250473022461,
"date_start": "2024-07-01T13:44:11+00:00",
"date_finish": "2024-07-01T13:44:11+00:00",
"operating_reset_at": 1719842051,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Move folder
Moves one folder inside another
`Function MoveFolder(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| DestinationID | --tagetid | String, Number | ID of target folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_moveto.php)
:::
<br/>
```bsl title="Code example"
DestinationID = "5014";
FolderID = "5020";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID);
FolderID = "5018";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MoveFolder --url "b24-ar17wx.bitrix24.by" --folderid "2492" --tagetid "2488" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "938",
"NAME": "New subfolder 2",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "938",
"PARENT_ID": 934,
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-01T13:44:06+00:00",
"UPDATE_TIME": "2024-07-01T13:44:07+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New folder 2/New subfolder 2"
},
"time": {
"start": 1719841451.89089,
"finish": 1719841451.95846,
"duration": 0.0675740242004394,
"processing": 0.0360250473022461,
"date_start": "2024-07-01T13:44:11+00:00",
"date_finish": "2024-07-01T13:44:11+00:00",
"operating_reset_at": 1719842051,
"operating": 0
}
}
```

168
docs/en/md/Bitrix24/Catalogs-managment/Rename-folder.md
View File

@ -1,84 +1,84 @@
---
sidebar_position: 10
---
# Rename folder
Change folder name
`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Name | --title | String | New folders name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php)
:::
<br/>
```bsl title="Code example"
Name = "New catalog";
Filename2 = "New folder 2";
FolderID2 = "5014";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2);
FolderID = "5016";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "936",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "936",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-01T13:44:01+00:00",
"UPDATE_TIME": "2024-07-01T13:44:01+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719841443.11172,
"finish": 1719841443.16013,
"duration": 0.0484049320220947,
"processing": 0.0123419761657715,
"date_start": "2024-07-01T13:44:03+00:00",
"date_finish": "2024-07-01T13:44:03+00:00",
"operating_reset_at": 1719842043,
"operating": 0
}
}
```
---
sidebar_position: 10
---
# Rename folder
Change folder name
`Function RenameFolder(Val URL, Val FolderID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Name | --title | String | New folders name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_rename.php)
:::
<br/>
```bsl title="Code example"
Name = "New catalog";
Filename2 = "New folder 2";
FolderID2 = "5014";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2);
FolderID = "5016";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenameFolder(URL, FolderID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --title %title% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "936",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "936",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-01T13:44:01+00:00",
"UPDATE_TIME": "2024-07-01T13:44:01+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719841443.11172,
"finish": 1719841443.16013,
"duration": 0.0484049320220947,
"processing": 0.0123419761657715,
"date_start": "2024-07-01T13:44:03+00:00",
"date_finish": "2024-07-01T13:44:03+00:00",
"operating_reset_at": 1719842043,
"operating": 0
}
}
```

158
docs/en/md/Bitrix24/Catalogs-managment/Restore-folder.md
View File

@ -1,79 +1,79 @@
---
sidebar_position: 9
---
# Restore folder
Resotre folder form recycle bin
`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 RestoreFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "936",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "936",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-01T13:44:01+00:00",
"UPDATE_TIME": "2024-07-01T13:44:13+00:00",
"DELETE_TIME": "2024-07-01T13:44:12+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719841454.36238,
"finish": 1719841454.40451,
"duration": 0.0421350002288818,
"processing": 0.00979709625244141,
"date_start": "2024-07-01T13:44:14+00:00",
"date_finish": "2024-07-01T13:44:14+00:00",
"operating_reset_at": 1719842054,
"operating": 0
}
}
```
---
sidebar_position: 9
---
# Restore folder
Resotre folder form recycle bin
`Function RestoreFolder(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_restore.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FolderID = "5016";
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 RestoreFolder --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "936",
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": "936",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"CREATE_TIME": "2024-07-01T13:44:01+00:00",
"UPDATE_TIME": "2024-07-01T13:44:13+00:00",
"DELETE_TIME": "2024-07-01T13:44:12+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719841454.36238,
"finish": 1719841454.40451,
"duration": 0.0421350002288818,
"processing": 0.00979709625244141,
"date_start": "2024-07-01T13:44:14+00:00",
"date_finish": "2024-07-01T13:44:14+00:00",
"operating_reset_at": 1719842054,
"operating": 0
}
}
```

142
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Add-users-to-chat.md
View File

@ -1,71 +1,71 @@
---
sidebar_position: 5
---
# Add users to chat
Adds users to the chat by ID array
`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| UserIDs | --users | Array of string, number | New members IDs |
| HideHistory | --hide | Boolean | Hide old messages from new members |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
UserIDs = New Array;
UserIDs.Add(10);
UserIDs.Add(12);
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
UserID = 10;
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token);
```
```sh title="CLI command example"
oint bitrix24 AddUsersToChat --url %url% --chat %chat% --users %users% --hide %hide% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865686.43672,
"finish": 1720865686.52541,
"duration": 0.0886859893798828,
"processing": 0.0491659641265869,
"date_start": "2024-07-13T10:14:46+00:00",
"date_finish": "2024-07-13T10:14:46+00:00",
"operating_reset_at": 1720866286,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Add users to chat
Adds users to the chat by ID array
`Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| UserIDs | --users | Array of string, number | New members IDs |
| HideHistory | --hide | Boolean | Hide old messages from new members |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
UserIDs = New Array;
UserIDs.Add(10);
UserIDs.Add(12);
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
UserID = 10;
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token);
```
```sh title="CLI command example"
oint bitrix24 AddUsersToChat --url %url% --chat %chat% --users %users% --hide %hide% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865686.43672,
"finish": 1720865686.52541,
"duration": 0.0886859893798828,
"processing": 0.0491659641265869,
"date_start": "2024-07-13T10:14:46+00:00",
"date_finish": "2024-07-13T10:14:46+00:00",
"operating_reset_at": 1720866286,
"operating": 0
}
}
```

142
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-color.md
View File

@ -1,71 +1,71 @@
---
sidebar_position: 8
---
# Change chat color
Chat chat color for mobile app
`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Color | --color | String | New chat color |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::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
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Color = "AZURE";
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Color = "PURPLE";
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatColor --url %url% --chat %chat% --color %color% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865688.95778,
"finish": 1720865689.02493,
"duration": 0.0671589374542236,
"processing": 0.0428512096405029,
"date_start": "2024-07-13T10:14:48+00:00",
"date_finish": "2024-07-13T10:14:49+00:00",
"operating_reset_at": 1720866288,
"operating": 0
}
}
```
---
sidebar_position: 8
---
# Change chat color
Chat chat color for mobile app
`Function ChangeChatColor(Val URL, Val ChatID, Val Color, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Color | --color | String | New chat color |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::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
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Color = "AZURE";
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Color = "PURPLE";
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatColor --url %url% --chat %chat% --color %color% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865688.95778,
"finish": 1720865689.02493,
"duration": 0.0671589374542236,
"processing": 0.0428512096405029,
"date_start": "2024-07-13T10:14:48+00:00",
"date_finish": "2024-07-13T10:14:49+00:00",
"operating_reset_at": 1720866288,
"operating": 0
}
}
```

134
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-owner.md
View File

@ -1,67 +1,67 @@
---
sidebar_position: 10
---
# Change chat owner
Change chat owner
`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| UserID | --user | String, Number | User ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
UserID = 10;
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatOwner --url %url% --chat %chat% --user %user% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865697.10595,
"finish": 1720865697.13924,
"duration": 0.0332820415496826,
"processing": 0.0104668140411377,
"date_start": "2024-07-13T10:14:57+00:00",
"date_finish": "2024-07-13T10:14:57+00:00",
"operating_reset_at": 1720866297,
"operating": 0
}
}
```
---
sidebar_position: 10
---
# Change chat owner
Change chat owner
`Function ChangeChatOwner(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| UserID | --user | String, Number | User ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12111)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
UserID = 10;
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatOwner --url %url% --chat %chat% --user %user% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865697.10595,
"finish": 1720865697.13924,
"duration": 0.0332820415496826,
"processing": 0.0104668140411377,
"date_start": "2024-07-13T10:14:57+00:00",
"date_finish": "2024-07-13T10:14:57+00:00",
"operating_reset_at": 1720866297,
"operating": 0
}
}
```

134
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-picture.md
View File

@ -1,67 +1,67 @@
---
sidebar_position: 9
---
# Change chat picture
Setup new chat picture
`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Image | --picture | String, BinaryData | Picture data |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Image = "https://openintegrations.dev/test_data/picture2.jpg";
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatPicture --url %url% --chat %chat% --picture %picture% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865692.90718,
"finish": 1720865693.81896,
"duration": 0.91178297996521,
"processing": 0.884725093841553,
"date_start": "2024-07-13T10:14:52+00:00",
"date_finish": "2024-07-13T10:14:53+00:00",
"operating_reset_at": 1720866292,
"operating": 0.884703874588013
}
}
```
---
sidebar_position: 9
---
# Change chat picture
Setup new chat picture
`Function ChangeChatPicture(Val URL, Val ChatID, Val Image, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Image | --picture | String, BinaryData | Picture data |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12109)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Image = "https://openintegrations.dev/test_data/picture2.jpg";
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatPicture --url %url% --chat %chat% --picture %picture% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865692.90718,
"finish": 1720865693.81896,
"duration": 0.91178297996521,
"processing": 0.884725093841553,
"date_start": "2024-07-13T10:14:52+00:00",
"date_finish": "2024-07-13T10:14:53+00:00",
"operating_reset_at": 1720866292,
"operating": 0.884703874588013
}
}
```

138
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Change-chat-title.md
View File

@ -1,69 +1,69 @@
---
sidebar_position: 7
---
# Change chat title
Change text of chat title
`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Title | --title | String | New title |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Title = "New chat title";
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Title = "Another title";
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatTitle --url %url% --chat %chat% --title %title% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865687.70928,
"finish": 1720865687.78107,
"duration": 0.0717928409576416,
"processing": 0.0479631423950195,
"date_start": "2024-07-13T10:14:47+00:00",
"date_finish": "2024-07-13T10:14:47+00:00",
"operating_reset_at": 1720866287,
"operating": 0
}
}
```
---
sidebar_position: 7
---
# Change chat title
Change text of chat title
`Function ChangeChatTitle(Val URL, Val ChatID, Val Title, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Title | --title | String | New title |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12105)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Title = "New chat title";
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Title = "Another title";
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title, Token);
```
```sh title="CLI command example"
oint bitrix24 ChangeChatTitle --url %url% --chat %chat% --title %title% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865687.70928,
"finish": 1720865687.78107,
"duration": 0.0717928409576416,
"processing": 0.0479631423950195,
"date_start": "2024-07-13T10:14:47+00:00",
"date_finish": "2024-07-13T10:14:47+00:00",
"operating_reset_at": 1720866287,
"operating": 0
}
}
```

172
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Create-chat.md
View File

@ -1,86 +1,86 @@
---
sidebar_position: 1
---
# Create chat
Creates a new chat based on the field structure
`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093)
:::
<br/>
```bsl title="Code example"
Image = "https://openintegrations.dev/test_data/picture.jpg";
OPI_TypeConversion.GetBinaryData(Image);
B64Image = GetBase64StringFromBinaryData(Image);
MembersArray = New Array;
MembersArray.Add(10);
MembersArray.Add(1);
ChatStructure = New Structure;
ChatStructure.Insert("TYPE", "OPEN");
ChatStructure.Insert("TITLE", "New chat");
ChatStructure.Insert("DESCRIPTION", "This is a new chat");
ChatStructure.Insert("COLOR", "GREEN");
ChatStructure.Insert("MESSAGE", "Welcome to new chat");
ChatStructure.Insert("USERS", MembersArray);
ChatStructure.Insert("AVATAR", B64Image);
ChatStructure.Insert("OWNER_ID", 1);
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatStructure = New Structure;
ChatStructure.Insert("TYPE", "CHAT");
ChatStructure.Insert("TITLE", "Private chat");
ChatStructure.Insert("USERS", MembersArray);
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateChat --url %url% --fields %fields% --token %token%
```
```json title="Result"
{
"result": 26,
"time": {
"start": 1720816597.42171,
"finish": 1720816597.52933,
"duration": 0.107618093490601,
"processing": 0.081672191619873,
"date_start": "2024-07-12T20:36:37+00:00",
"date_finish": "2024-07-12T20:36:37+00:00",
"operating_reset_at": 1720817197,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Create chat
Creates a new chat based on the field structure
`Function CreateChat(Val URL, Val ChatStructure, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatStructure | --fields | Structure of KeyAndValue | Chat fields structure. See GetChatStructure |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12093)
:::
<br/>
```bsl title="Code example"
Image = "https://openintegrations.dev/test_data/picture.jpg";
OPI_TypeConversion.GetBinaryData(Image);
B64Image = GetBase64StringFromBinaryData(Image);
MembersArray = New Array;
MembersArray.Add(10);
MembersArray.Add(1);
ChatStructure = New Structure;
ChatStructure.Insert("TYPE", "OPEN");
ChatStructure.Insert("TITLE", "New chat");
ChatStructure.Insert("DESCRIPTION", "This is a new chat");
ChatStructure.Insert("COLOR", "GREEN");
ChatStructure.Insert("MESSAGE", "Welcome to new chat");
ChatStructure.Insert("USERS", MembersArray);
ChatStructure.Insert("AVATAR", B64Image);
ChatStructure.Insert("OWNER_ID", 1);
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatStructure = New Structure;
ChatStructure.Insert("TYPE", "CHAT");
ChatStructure.Insert("TITLE", "Private chat");
ChatStructure.Insert("USERS", MembersArray);
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateChat --url %url% --fields %fields% --token %token%
```
```json title="Result"
{
"result": 26,
"time": {
"start": 1720816597.42171,
"finish": 1720816597.52933,
"duration": 0.107618093490601,
"processing": 0.081672191619873,
"date_start": "2024-07-12T20:36:37+00:00",
"date_finish": "2024-07-12T20:36:37+00:00",
"operating_reset_at": 1720817197,
"operating": 0
}
}
```

134
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Delete-user-from-chat.md
View File

@ -1,67 +1,67 @@
---
sidebar_position: 6
---
# Delete user from chat
Deletes user from chat
`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| UserID | --user | String, Number | User ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
UserID = 10;
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteUserFromChat --url %url% --chat %chat% --user %user% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865685.25089,
"finish": 1720865685.32425,
"duration": 0.0733590126037598,
"processing": 0.0480890274047852,
"date_start": "2024-07-13T10:14:45+00:00",
"date_finish": "2024-07-13T10:14:45+00:00",
"operating_reset_at": 1720866285,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Delete user from chat
Deletes user from chat
`Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| UserID | --user | String, Number | User ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12099)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
UserID = 10;
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteUserFromChat --url %url% --chat %chat% --user %user% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865685.25089,
"finish": 1720865685.32425,
"duration": 0.0733590126037598,
"processing": 0.0480890274047852,
"date_start": "2024-07-13T10:14:45+00:00",
"date_finish": "2024-07-13T10:14:45+00:00",
"operating_reset_at": 1720866285,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Disable-chat-notifications.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 11
---
# Disable chat notifications
Disable chat notifications
`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 DisableChatNotifications --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865694.86568,
"finish": 1720865694.9092,
"duration": 0.0435128211975098,
"processing": 0.0169928073883057,
"date_start": "2024-07-13T10:14:54+00:00",
"date_finish": "2024-07-13T10:14:54+00:00",
"operating_reset_at": 1720866294,
"operating": 0
}
}
```
---
sidebar_position: 11
---
# Disable chat notifications
Disable chat notifications
`Function DisableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 DisableChatNotifications --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865694.86568,
"finish": 1720865694.9092,
"duration": 0.0435128211975098,
"processing": 0.0169928073883057,
"date_start": "2024-07-13T10:14:54+00:00",
"date_finish": "2024-07-13T10:14:54+00:00",
"operating_reset_at": 1720866294,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Enable-chat-notifications.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 12
---
# Enable chat notifications
Enable chat notifications
`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 EnableChatNotifications --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865695.99933,
"finish": 1720865696.04205,
"duration": 0.0427119731903076,
"processing": 0.0170090198516846,
"date_start": "2024-07-13T10:14:55+00:00",
"date_finish": "2024-07-13T10:14:56+00:00",
"operating_reset_at": 1720866296,
"operating": 0
}
}
```
---
sidebar_position: 12
---
# Enable chat notifications
Enable chat notifications
`Function EnableChatNotifications(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11473)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 EnableChatNotifications --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720865695.99933,
"finish": 1720865696.04205,
"duration": 0.0427119731903076,
"processing": 0.0170090198516846,
"date_start": "2024-07-13T10:14:55+00:00",
"date_finish": "2024-07-13T10:14:56+00:00",
"operating_reset_at": 1720866296,
"operating": 0
}
}
```

132
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-files-folder.md
View File

@ -1,66 +1,66 @@
---
sidebar_position: 20
---
# Get chat files folder
Get information about folder for chat files
`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatFilesFolder --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": {
"ID": 3250
},
"time": {
"start": 1720969169.10256,
"finish": 1720969169.1584,
"duration": 0.0558350086212158,
"processing": 0.0327038764953613,
"date_start": "2024-07-14T14:59:29+00:00",
"date_finish": "2024-07-14T14:59:29+00:00",
"operating_reset_at": 1720969769,
"operating": 0
}
}
```
---
sidebar_position: 20
---
# Get chat files folder
Get information about folder for chat files
`Function GetChatFilesFolder(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11483)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatFilesFolder --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": {
"ID": 3250
},
"time": {
"start": 1720969169.10256,
"finish": 1720969169.1584,
"duration": 0.0558350086212158,
"processing": 0.0327038764953613,
"date_start": "2024-07-14T14:59:29+00:00",
"date_finish": "2024-07-14T14:59:29+00:00",
"operating_reset_at": 1720969769,
"operating": 0
}
}
```

240
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-members-list.md
View File

@ -1,120 +1,120 @@
---
sidebar_position: 15
---
# Get chat members list
Get chat members list
`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatMembersList --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": [
{
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"bot_data": null
},
{
"id": 1,
"active": true,
"name": "Anton Titovets",
"first_name": "Anton",
"last_name": "Titovets",
"work_position": null,
"color": "#df532d",
"avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-14T09:00:58+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"bot_data": null
}
],
"total": 2,
"time": {
"start": 1720969161.4388,
"finish": 1720969161.46946,
"duration": 0.0306570529937744,
"processing": 0.00571608543395996,
"date_start": "2024-07-14T14:59:21+00:00",
"date_finish": "2024-07-14T14:59:21+00:00",
"operating_reset_at": 1720969761,
"operating": 0
}
}
```
---
sidebar_position: 15
---
# Get chat members list
Get chat members list
`Function GetChatMembersList(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23800)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetChatMembersList(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatMembersList --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": [
{
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"bot_data": null
},
{
"id": 1,
"active": true,
"name": "Anton Titovets",
"first_name": "Anton",
"last_name": "Titovets",
"work_position": null,
"color": "#df532d",
"avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-14T09:00:58+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"bot_data": null
}
],
"total": 2,
"time": {
"start": 1720969161.4388,
"finish": 1720969161.46946,
"duration": 0.0306570529937744,
"processing": 0.00571608543395996,
"date_start": "2024-07-14T14:59:21+00:00",
"date_finish": "2024-07-14T14:59:21+00:00",
"operating_reset_at": 1720969761,
"operating": 0
}
}
```

798
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-messages-list.md
View File

@ -1,399 +1,399 @@
---
sidebar_position: 13
---
# Get chat messages list
Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified
`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| LastID | --last | String, Number | Id of last message |
| FirstID | --first | String, Number | ID of first message |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat4";
Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatMessagesList --url %url% --chat %chat% --last %last% --first %first% --token %token%
```
```json title="Result"
{
"result": {
"chat_id": 10,
"messages": [
{
"id": 3854,
"chat_id": 10,
"author_id": 10,
"date": "2024-07-13T14:54:43+00:00",
"text": "Write it!",
"unread": false,
"uuid": "700d361d-8324-47fb-b989-647949c1c899",
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4286,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T16:06:51+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4366,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T16:40:58+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4406,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T19:57:33+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4446,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T20:21:27+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4486,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T20:22:30+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4526,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T20:41:21+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4668,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:10:33+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4708,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:22:56+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4748,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:26:01+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4788,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:28:01+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4828,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:28:36+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4868,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:30:18+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4908,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:52:24+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4948,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:53:31+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4990,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:57:06+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5060,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:59:43+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5140,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T09:29:40+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5182,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T09:35:56+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5262,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T11:27:54+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
}
],
"users": [
{
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"desktop_last_date": false
},
{
"id": 1,
"active": true,
"name": "Anton Titovets",
"first_name": "Anton",
"last_name": "Titovets",
"work_position": null,
"color": "#df532d",
"avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-14T09:00:58+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"desktop_last_date": false
}
],
"files": []
},
"time": {
"start": 1720969156.38474,
"finish": 1720969156.42064,
"duration": 0.0358970165252686,
"processing": 0.0108029842376709,
"date_start": "2024-07-14T14:59:16+00:00",
"date_finish": "2024-07-14T14:59:16+00:00",
"operating_reset_at": 1720969756,
"operating": 0
}
}
```
---
sidebar_position: 13
---
# Get chat messages list
Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified
`Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| LastID | --last | String, Number | Id of last message |
| FirstID | --first | String, Number | ID of first message |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=11479)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat4";
Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatMessagesList --url %url% --chat %chat% --last %last% --first %first% --token %token%
```
```json title="Result"
{
"result": {
"chat_id": 10,
"messages": [
{
"id": 3854,
"chat_id": 10,
"author_id": 10,
"date": "2024-07-13T14:54:43+00:00",
"text": "Write it!",
"unread": false,
"uuid": "700d361d-8324-47fb-b989-647949c1c899",
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4286,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T16:06:51+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4366,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T16:40:58+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4406,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T19:57:33+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4446,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T20:21:27+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4486,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T20:22:30+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4526,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-13T20:41:21+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4668,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:10:33+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4708,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:22:56+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4748,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:26:01+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4788,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:28:01+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4828,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:28:36+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4868,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:30:18+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4908,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:52:24+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4948,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:53:31+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4990,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:57:06+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5060,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T08:59:43+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5140,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T09:29:40+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5182,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T09:35:56+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 5262,
"chat_id": 10,
"author_id": 1,
"date": "2024-07-14T11:27:54+00:00",
"text": "This message was deleted",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
}
],
"users": [
{
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"desktop_last_date": false
},
{
"id": 1,
"active": true,
"name": "Anton Titovets",
"first_name": "Anton",
"last_name": "Titovets",
"work_position": null,
"color": "#df532d",
"avatar": "https://cdn-ru.bitrix24.by/b28528874/resize_cache/30/ff58db95aecdfa09ae61b51b5fd8f63f/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-14T09:00:58+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false,
"desktop_last_date": false
}
],
"files": []
},
"time": {
"start": 1720969156.38474,
"finish": 1720969156.42064,
"duration": 0.0358970165252686,
"processing": 0.0108029842376709,
"date_start": "2024-07-14T14:59:16+00:00",
"date_finish": "2024-07-14T14:59:16+00:00",
"operating_reset_at": 1720969756,
"operating": 0
}
}
```

66
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-structure.md
View File

@ -1,33 +1,33 @@
---
sidebar_position: 21
---
# Get chats structure
Get chat fields structure
`Function GetChatStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
Returns: Structure of KeyAndValue - Fields structure
<br/>
```sh title="CLI command example"
oint bitrix24 GetChatStructure --empty %empty%
```
---
sidebar_position: 21
---
# Get chats structure
Get chat fields structure
`Function GetChatStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
Returns: Structure of KeyAndValue - Fields structure
<br/>
```sh title="CLI command example"
oint bitrix24 GetChatStructure --empty %empty%
```

134
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-chat-users.md
View File

@ -1,67 +1,67 @@
---
sidebar_position: 2
---
# Get chats users
Gets the list of chat users by ID
`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatUsers --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": [
1,
10
],
"time": {
"start": 1720816598.61771,
"finish": 1720816598.64882,
"duration": 0.0311079025268555,
"processing": 0.00316882133483887,
"date_start": "2024-07-12T20:36:38+00:00",
"date_finish": "2024-07-12T20:36:38+00:00",
"operating_reset_at": 1720817198,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Get chats users
Gets the list of chat users by ID
`Function GetChatUsers(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12095)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetChatUsers --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": [
1,
10
],
"time": {
"start": 1720816598.61771,
"finish": 1720816598.64882,
"duration": 0.0311079025268555,
"processing": 0.00316882133483887,
"date_start": "2024-07-12T20:36:38+00:00",
"date_finish": "2024-07-12T20:36:38+00:00",
"operating_reset_at": 1720817198,
"operating": 0
}
}
```

266
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-dialog.md
View File

@ -1,133 +1,133 @@
---
sidebar_position: 14
---
# Get dialog
Get chat data by ID
`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Result = OPI_Bitrix24.GetDialog(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetDialog(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDialog --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": {
"id": 10,
"parent_chat_id": 0,
"parent_message_id": 0,
"name": "",
"description": "",
"owner": 10,
"extranet": false,
"avatar": "",
"color": "#ab7761",
"type": "private",
"counter": 1,
"user_counter": 0,
"message_count": 24,
"unread_id": 3854,
"restrictions": {
"avatar": true,
"rename": true,
"extend": true,
"call": true,
"mute": true,
"leave": true,
"leave_owner": true,
"send": true,
"user_list": true
},
"last_message_id": 5262,
"last_id": 3852,
"marked_id": 0,
"disk_folder_id": 0,
"entity_type": "",
"entity_id": "",
"entity_data_1": "",
"entity_data_2": "",
"entity_data_3": "",
"mute_list": [],
"date_create": "2024-06-15T16:48:49+00:00",
"message_type": "P",
"disappearing_time": 0,
"public": "",
"role": "member",
"entity_link": {
"type": "",
"url": ""
},
"permissions": {
"manage_users_add": "member",
"manage_users_delete": "manager",
"manage_ui": "member",
"manage_settings": "owner",
"manage_messages": "member",
"can_post": "member"
},
"is_new": false,
"readed_list": [
{
"user_id": 10,
"user_name": "Techno Pizza",
"message_id": 3854,
"date": null
}
],
"manager_list": [],
"last_message_views": {
"message_id": 5262,
"first_viewers": [],
"count_of_viewers": 0
},
"dialog_id": "10"
},
"time": {
"start": 1720969160.19046,
"finish": 1720969160.22782,
"duration": 0.037362813949585,
"processing": 0.0134620666503906,
"date_start": "2024-07-14T14:59:20+00:00",
"date_finish": "2024-07-14T14:59:20+00:00",
"operating_reset_at": 1720969760,
"operating": 0
}
}
```
---
sidebar_position: 14
---
# Get dialog
Get chat data by ID
`Function GetDialog(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12886)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Result = OPI_Bitrix24.GetDialog(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetDialog(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDialog --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": {
"id": 10,
"parent_chat_id": 0,
"parent_message_id": 0,
"name": "",
"description": "",
"owner": 10,
"extranet": false,
"avatar": "",
"color": "#ab7761",
"type": "private",
"counter": 1,
"user_counter": 0,
"message_count": 24,
"unread_id": 3854,
"restrictions": {
"avatar": true,
"rename": true,
"extend": true,
"call": true,
"mute": true,
"leave": true,
"leave_owner": true,
"send": true,
"user_list": true
},
"last_message_id": 5262,
"last_id": 3852,
"marked_id": 0,
"disk_folder_id": 0,
"entity_type": "",
"entity_id": "",
"entity_data_1": "",
"entity_data_2": "",
"entity_data_3": "",
"mute_list": [],
"date_create": "2024-06-15T16:48:49+00:00",
"message_type": "P",
"disappearing_time": 0,
"public": "",
"role": "member",
"entity_link": {
"type": "",
"url": ""
},
"permissions": {
"manage_users_add": "member",
"manage_users_delete": "manager",
"manage_ui": "member",
"manage_settings": "owner",
"manage_messages": "member",
"can_post": "member"
},
"is_new": false,
"readed_list": [
{
"user_id": 10,
"user_name": "Techno Pizza",
"message_id": 3854,
"date": null
}
],
"manager_list": [],
"last_message_views": {
"message_id": 5262,
"first_viewers": [],
"count_of_viewers": 0
},
"dialog_id": "10"
},
"time": {
"start": 1720969160.19046,
"finish": 1720969160.22782,
"duration": 0.037362813949585,
"processing": 0.0134620666503906,
"date_start": "2024-07-14T14:59:20+00:00",
"date_finish": "2024-07-14T14:59:20+00:00",
"operating_reset_at": 1720969760,
"operating": 0
}
}
```

104
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-user-status.md
View File

@ -1,52 +1,52 @@
---
sidebar_position: 17
---
# Get user status
Gets the status (online) of the current user
`Function GetUserStatus(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetUserStatus(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetUserStatus(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUserStatus --url %url% --token %token%
```
```json title="Result"
{
"error": "expired_token",
"error_description": "The access token provided has expired."
}
```
---
sidebar_position: 17
---
# Get user status
Gets the status (online) of the current user
`Function GetUserStatus(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11497)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetUserStatus(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetUserStatus(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUserStatus --url %url% --token %token%
```
```json title="Result"
{
"error": "expired_token",
"error_description": "The access token provided has expired."
}
```

188
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Get-users.md
View File

@ -1,94 +1,94 @@
---
sidebar_position: 4
---
# Get users
Get users information for dialog
`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ArrayOfUsers = New Array;
ArrayOfUsers.Add(1);
ArrayOfUsers.Add(10);
Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserIDs = 10;
Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUsers --url %url% --users %users% --token %token%
```
```json title="Result"
{
"result": {
"10": {
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false
}
},
"time": {
"start": 1722083796.56495,
"finish": 1722083796.59641,
"duration": 0.031451940536499,
"processing": 0.00229191780090332,
"date_start": "2024-07-27T12:36:36+00:00",
"date_finish": "2024-07-27T12:36:36+00:00",
"operating_reset_at": 1722084396,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Get users
Get users information for dialog
`Function GetUsers(Val URL, Val UserIDs, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserIDs | --users | Array of String, Number | Usesr ID or array of users IDs |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11493)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ArrayOfUsers = New Array;
ArrayOfUsers.Add(1);
ArrayOfUsers.Add(10);
Result = OPI_Bitrix24.GetUsers(URL, ArrayOfUsers);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserIDs = 10;
Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token);
```
```sh title="CLI command example"
oint bitrix24 GetUsers --url %url% --users %users% --token %token%
```
```json title="Result"
{
"result": {
"10": {
"id": 10,
"active": true,
"name": "Techno Pizza",
"first_name": "Techno",
"last_name": "Pizza",
"work_position": null,
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2024-07-13T18:36:23+00:00",
"mobile_last_date": false,
"absent": false,
"departments": [
1
],
"phones": false
}
},
"time": {
"start": 1722083796.56495,
"finish": 1722083796.59641,
"duration": 0.031451940536499,
"processing": 0.00229191780090332,
"date_start": "2024-07-27T12:36:36+00:00",
"date_finish": "2024-07-27T12:36:36+00:00",
"operating_reset_at": 1722084396,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 3
---
# Leave chat
Removes the current user from the chat room
`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.LeaveChat(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 LeaveChat --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816599.74716,
"finish": 1720816599.81746,
"duration": 0.0702948570251465,
"processing": 0.0438079833984375,
"date_start": "2024-07-12T20:36:39+00:00",
"date_finish": "2024-07-12T20:36:39+00:00",
"operating_reset_at": 1720817199,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Leave chat
Removes the current user from the chat room
`Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.LeaveChat(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 LeaveChat --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816599.74716,
"finish": 1720816599.81746,
"duration": 0.0702948570251465,
"processing": 0.0438079833984375,
"date_start": "2024-07-12T20:36:39+00:00",
"date_finish": "2024-07-12T20:36:39+00:00",
"operating_reset_at": 1720817199,
"operating": 0
}
}
```

122
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Read-all.md
View File

@ -1,61 +1,61 @@
---
sidebar_position: 19
---
# Read all
Mark all message as readed
`Function ReadAll(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.ReadAll(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.ReadAll(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 ReadAll --url %url% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969176.30834,
"finish": 1720969176.34001,
"duration": 0.0316698551177978,
"processing": 0.00501918792724609,
"date_start": "2024-07-14T14:59:36+00:00",
"date_finish": "2024-07-14T14:59:36+00:00",
"operating_reset_at": 1720969776,
"operating": 0
}
}
```
---
sidebar_position: 19
---
# Read all
Mark all message as readed
`Function ReadAll(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23804)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.ReadAll(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.ReadAll(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 ReadAll --url %url% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969176.30834,
"finish": 1720969176.34001,
"duration": 0.0316698551177978,
"processing": 0.00501918792724609,
"date_start": "2024-07-14T14:59:36+00:00",
"date_finish": "2024-07-14T14:59:36+00:00",
"operating_reset_at": 1720969776,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Send-writing-notification.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 16
---
# Send write notification
Send Writing... status to dialog...
`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 SendWritingNotification --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969162.6704,
"finish": 1720969162.69719,
"duration": 0.0267889499664307,
"processing": 0.000684022903442383,
"date_start": "2024-07-14T14:59:22+00:00",
"date_finish": "2024-07-14T14:59:22+00:00",
"operating_reset_at": 1720969762,
"operating": 0
}
}
```
---
sidebar_position: 16
---
# Send write notification
Send Writing... status to dialog...
`Function SendWritingNotification(Val URL, Val ChatID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=23802)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.SendWritingNotification(URL, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 SendWritingNotification --url %url% --chat %chat% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969162.6704,
"finish": 1720969162.69719,
"duration": 0.0267889499664307,
"processing": 0.000684022903442383,
"date_start": "2024-07-14T14:59:22+00:00",
"date_finish": "2024-07-14T14:59:22+00:00",
"operating_reset_at": 1720969762,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Chats-and-dialogs-managment/Set-user-status.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 18
---
# Set user status
Sets the status (online) of the current user
`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Status | --status | String, Number | Status value: online, dnd, away |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Status = "dnd";
Result = OPI_Bitrix24.SetUserStatus(URL, Status);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Status = "away";
Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);
```
```sh title="CLI command example"
oint bitrix24 SetUserStatus --url %url% --status %status% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722083795.3692,
"finish": 1722083795.39818,
"duration": 0.0289750099182129,
"processing": 0.00522208213806152,
"date_start": "2024-07-27T12:36:35+00:00",
"date_finish": "2024-07-27T12:36:35+00:00",
"operating_reset_at": 1722084395,
"operating": 0
}
}
```
---
sidebar_position: 18
---
# Set user status
Sets the status (online) of the current user
`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Status | --status | String, Number | Status value: online, dnd, away |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Status = "dnd";
Result = OPI_Bitrix24.SetUserStatus(URL, Status);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Status = "away";
Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);
```
```sh title="CLI command example"
oint bitrix24 SetUserStatus --url %url% --status %status% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722083795.3692,
"finish": 1722083795.39818,
"duration": 0.0289750099182129,
"processing": 0.00522208213806152,
"date_start": "2024-07-27T12:36:35+00:00",
"date_finish": "2024-07-27T12:36:35+00:00",
"operating_reset_at": 1722084395,
"operating": 0
}
}
```

136
docs/en/md/Bitrix24/Comments-and-results-managment/Add-task-comment.md
View File

@ -1,68 +1,68 @@
---
sidebar_position: 3
---
# Add comment to task
Create new comment to the task
`Function AddTaskComment(Val URL, Val TaskID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
Text = "Task impossible, let's split up";
Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Text = "Task uninpossible, don't split up";
Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 1376,
"time": {
"start": 1720186702.77405,
"finish": 1720186703.52768,
"duration": 0.753632068634033,
"processing": 0.724568128585816,
"date_start": "2024-07-05T13:38:22+00:00",
"date_finish": "2024-07-05T13:38:23+00:00",
"operating_reset_at": 1720187302,
"operating": 0.724542856216431
}
}
```
---
sidebar_position: 3
---
# Add comment to task
Create new comment to the task
`Function AddTaskComment(Val URL, Val TaskID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
Text = "Task impossible, let's split up";
Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Text = "Task uninpossible, don't split up";
Result = OPI_Bitrix24.AddTaskComment(URL, TaskID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --text %text% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 1376,
"time": {
"start": 1720186702.77405,
"finish": 1720186703.52768,
"duration": 0.753632068634033,
"processing": 0.724568128585816,
"date_start": "2024-07-05T13:38:22+00:00",
"date_finish": "2024-07-05T13:38:23+00:00",
"operating_reset_at": 1720187302,
"operating": 0.724542856216431
}
}
```

150
docs/en/md/Bitrix24/Comments-and-results-managment/Create-result-from-comment.md
View File

@ -1,75 +1,75 @@
---
sidebar_position: 7
---
# Create result from comment
Create task result from comment
`Function CreateResultFromComment(Val URL, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
CommentID = "2932";
Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"id": 130,
"taskId": 432,
"commentId": 1376,
"createdBy": 1,
"createdAt": "2024-07-05T13:38:22+00:00",
"updatedAt": "2024-07-05T13:38:22+00:00",
"status": 0,
"text": "The task has been changed, let's split up",
"formattedText": "The task has been changed, let's split up",
"files": null
},
"time": {
"start": 1720186706.85195,
"finish": 1720186706.92671,
"duration": 0.0747611522674561,
"processing": 0.0460391044616699,
"date_start": "2024-07-05T13:38:26+00:00",
"date_finish": "2024-07-05T13:38:26+00:00",
"operating_reset_at": 1720187306,
"operating": 0
}
}
```
---
sidebar_position: 7
---
# Create result from comment
Create task result from comment
`Function CreateResultFromComment(Val URL, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_addFromComment.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
CommentID = "2932";
Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"id": 130,
"taskId": 432,
"commentId": 1376,
"createdBy": 1,
"createdAt": "2024-07-05T13:38:22+00:00",
"updatedAt": "2024-07-05T13:38:22+00:00",
"status": 0,
"text": "The task has been changed, let's split up",
"formattedText": "The task has been changed, let's split up",
"files": null
},
"time": {
"start": 1720186706.85195,
"finish": 1720186706.92671,
"duration": 0.0747611522674561,
"processing": 0.0460391044616699,
"date_start": "2024-07-05T13:38:26+00:00",
"date_finish": "2024-07-05T13:38:26+00:00",
"operating_reset_at": 1720187306,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Comments-and-results-managment/Delete-result-from-comment.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 8
---
# Delete result from comment
Deletes task result, created from a comment
`Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
CommentID = "2932";
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720295536.04613,
"finish": 1720295536.09868,
"duration": 0.0525519847869873,
"processing": 0.0231878757476807,
"date_start": "2024-07-06T19:52:16+00:00",
"date_finish": "2024-07-06T19:52:16+00:00",
"operating_reset_at": 1720296136,
"operating": 0
}
}
```
---
sidebar_position: 8
---
# Delete result from comment
Deletes task result, created from a comment
`Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result_deleteFromComment.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
CommentID = "2932";
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720295536.04613,
"finish": 1720295536.09868,
"duration": 0.0525519847869873,
"processing": 0.0231878757476807,
"date_start": "2024-07-06T19:52:16+00:00",
"date_finish": "2024-07-06T19:52:16+00:00",
"operating_reset_at": 1720296136,
"operating": 0
}
}
```

132
docs/en/md/Bitrix24/Comments-and-results-managment/Delete-task-comment.md
View File

@ -1,66 +1,66 @@
---
sidebar_position: 5
---
# Delete comment
Delete task comment by ID
`Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | ID of comment to remove |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
CommentID = "2932";
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720295541.27592,
"finish": 1720295541.38076,
"duration": 0.104840040206909,
"processing": 0.0781040191650391,
"date_start": "2024-07-06T19:52:21+00:00",
"date_finish": "2024-07-06T19:52:21+00:00",
"operating_reset_at": 1720296141,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Delete comment
Delete task comment by ID
`Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | ID of comment to remove |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
CommentID = "2932";
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720295541.27592,
"finish": 1720295541.38076,
"duration": 0.104840040206909,
"processing": 0.0781040191650391,
"date_start": "2024-07-06T19:52:21+00:00",
"date_finish": "2024-07-06T19:52:21+00:00",
"operating_reset_at": 1720296141,
"operating": 0
}
}
```

66
docs/en/md/Bitrix24/Comments-and-results-managment/Get-comment-structure.md
View File

@ -1,33 +1,33 @@
---
sidebar_position: 9
---
# Get comment structure
Get comment fields structure
`Function GetCommentStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of KeyAndValue - Fields structure
<br/>
```sh title="CLI command example"
oint bitrix24 GetCommentStructure --empty %empty%
```
---
sidebar_position: 9
---
# Get comment structure
Get comment fields structure
`Function GetCommentStructure(Val Clear = False) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of KeyAndValue - Fields structure
<br/>
```sh title="CLI command example"
oint bitrix24 GetCommentStructure --empty %empty%
```

176
docs/en/md/Bitrix24/Comments-and-results-managment/Get-results-list.md
View File

@ -1,88 +1,88 @@
---
sidebar_position: 6
---
# Get results list
Gets results list for task
`Function GetResultsList(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
Result = OPI_Bitrix24.GetResultsList(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetResultsList(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetResultsList --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"id": 130,
"taskId": 432,
"commentId": 1376,
"createdBy": 1,
"createdAt": "2024-07-05T13:38:22+00:00",
"updatedAt": "2024-07-05T13:38:22+00:00",
"status": 0,
"text": "The task has been changed, let's split up",
"formattedText": "The task has been changed, let's split up",
"files": []
},
{
"id": 128,
"taskId": 432,
"commentId": 1374,
"createdBy": 1,
"createdAt": "2024-07-05T13:38:21+00:00",
"updatedAt": "2024-07-05T13:38:21+00:00",
"status": 0,
"text": "The task has been changed, do not split up",
"formattedText": "The task has been changed, do not split up",
"files": []
}
],
"time": {
"start": 1720186708.49595,
"finish": 1720186708.54066,
"duration": 0.044705867767334,
"processing": 0.00980901718139648,
"date_start": "2024-07-05T13:38:28+00:00",
"date_finish": "2024-07-05T13:38:28+00:00",
"operating_reset_at": 1720187308,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Get results list
Gets results list for task
`Function GetResultsList(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_result.list.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
Result = OPI_Bitrix24.GetResultsList(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetResultsList(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetResultsList --url "b24-ar17wx.bitrix24.by" --task "504" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"id": 130,
"taskId": 432,
"commentId": 1376,
"createdBy": 1,
"createdAt": "2024-07-05T13:38:22+00:00",
"updatedAt": "2024-07-05T13:38:22+00:00",
"status": 0,
"text": "The task has been changed, let's split up",
"formattedText": "The task has been changed, let's split up",
"files": []
},
{
"id": 128,
"taskId": 432,
"commentId": 1374,
"createdBy": 1,
"createdAt": "2024-07-05T13:38:21+00:00",
"updatedAt": "2024-07-05T13:38:21+00:00",
"status": 0,
"text": "The task has been changed, do not split up",
"formattedText": "The task has been changed, do not split up",
"files": []
}
],
"time": {
"start": 1720186708.49595,
"finish": 1720186708.54066,
"duration": 0.044705867767334,
"processing": 0.00980901718139648,
"date_start": "2024-07-05T13:38:28+00:00",
"date_finish": "2024-07-05T13:38:28+00:00",
"operating_reset_at": 1720187308,
"operating": 0
}
}
```

148
docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comment.md
View File

@ -1,74 +1,74 @@
---
sidebar_position: 2
---
# Get task comment
Gets task comment data by ID
`Function GetTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
CommentID = "2932";
TaskID = "1082";
Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"POST_MESSAGE_HTML": null,
"ID": "1496",
"AUTHOR_ID": "1",
"AUTHOR_NAME": "Anton Titovets",
"AUTHOR_EMAIL": "",
"POST_DATE": "2024-07-06T19:52:08+00:00",
"POST_MESSAGE": "The task has been changed, let's split up"
},
"time": {
"start": 1720295539.50621,
"finish": 1720295539.55446,
"duration": 0.0482499599456787,
"processing": 0.019589900970459,
"date_start": "2024-07-06T19:52:19+00:00",
"date_finish": "2024-07-06T19:52:19+00:00",
"operating_reset_at": 1720296139,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Get task comment
Gets task comment data by ID
`Function GetTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
CommentID = "2932";
TaskID = "1082";
Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"POST_MESSAGE_HTML": null,
"ID": "1496",
"AUTHOR_ID": "1",
"AUTHOR_NAME": "Anton Titovets",
"AUTHOR_EMAIL": "",
"POST_DATE": "2024-07-06T19:52:08+00:00",
"POST_MESSAGE": "The task has been changed, let's split up"
},
"time": {
"start": 1720295539.50621,
"finish": 1720295539.55446,
"duration": 0.0482499599456787,
"processing": 0.019589900970459,
"date_start": "2024-07-06T19:52:19+00:00",
"date_finish": "2024-07-06T19:52:19+00:00",
"operating_reset_at": 1720296139,
"operating": 0
}
}
```

164
docs/en/md/Bitrix24/Comments-and-results-managment/Get-task-comments-list.md
View File

@ -1,82 +1,82 @@
---
sidebar_position: 1
---
# Get comments list for a task
Get user comments list for a task
`Function GetTaskCommentsList(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTaskCommentsList --url %url% --task %task% --filter %filter% --token %token%
```
```json title="Result"
{
"result": [
{
"POST_MESSAGE_HTML": null,
"ID": "1494",
"AUTHOR_ID": "1",
"AUTHOR_NAME": "Anton Titovets",
"AUTHOR_EMAIL": "",
"POST_DATE": "2024-07-06T19:52:07+00:00",
"POST_MESSAGE": "The task has been changed, do not split up"
},
{
"POST_MESSAGE_HTML": null,
"ID": "1496",
"AUTHOR_ID": "1",
"AUTHOR_NAME": "Anton Titovets",
"AUTHOR_EMAIL": "",
"POST_DATE": "2024-07-06T19:52:08+00:00",
"POST_MESSAGE": "The task has been changed, let's split up"
}
],
"time": {
"start": 1720295537.77876,
"finish": 1720295537.83513,
"duration": 0.0563700199127197,
"processing": 0.0240809917449951,
"date_start": "2024-07-06T19:52:17+00:00",
"date_finish": "2024-07-06T19:52:17+00:00",
"operating_reset_at": 1720296137,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Get comments list for a task
Get user comments list for a task
`Function GetTaskCommentsList(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTaskCommentsList --url %url% --task %task% --filter %filter% --token %token%
```
```json title="Result"
{
"result": [
{
"POST_MESSAGE_HTML": null,
"ID": "1494",
"AUTHOR_ID": "1",
"AUTHOR_NAME": "Anton Titovets",
"AUTHOR_EMAIL": "",
"POST_DATE": "2024-07-06T19:52:07+00:00",
"POST_MESSAGE": "The task has been changed, do not split up"
},
{
"POST_MESSAGE_HTML": null,
"ID": "1496",
"AUTHOR_ID": "1",
"AUTHOR_NAME": "Anton Titovets",
"AUTHOR_EMAIL": "",
"POST_DATE": "2024-07-06T19:52:08+00:00",
"POST_MESSAGE": "The task has been changed, let's split up"
}
],
"time": {
"start": 1720295537.77876,
"finish": 1720295537.83513,
"duration": 0.0563700199127197,
"processing": 0.0240809917449951,
"date_start": "2024-07-06T19:52:17+00:00",
"date_finish": "2024-07-06T19:52:17+00:00",
"operating_reset_at": 1720296137,
"operating": 0
}
}
```

142
docs/en/md/Bitrix24/Comments-and-results-managment/Update-task-comment.md
View File

@ -1,71 +1,71 @@
---
sidebar_position: 4
---
# Update task comment
Changes task comment text
`Function UpdateTaskComment(Val URL, Val TaskID, Val CommentID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | CommentID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
CommentID = "2932";
Text = "The task has been changed, do not split up";
Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Text = "The task has been changed, let's split up";
Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720186705.11133,
"finish": 1720186705.21965,
"duration": 0.108311891555786,
"processing": 0.0788998603820801,
"date_start": "2024-07-05T13:38:25+00:00",
"date_finish": "2024-07-05T13:38:25+00:00",
"operating_reset_at": 1720187305,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Update task comment
Changes task comment text
`Function UpdateTaskComment(Val URL, Val TaskID, Val CommentID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | CommentID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/commentitem/update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1082";
CommentID = "2932";
Text = "The task has been changed, do not split up";
Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
CommentID = "2936";
Text = "The task has been changed, let's split up";
Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --text %text% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720186705.11133,
"finish": 1720186705.21965,
"duration": 0.108311891555786,
"processing": 0.0788998603820801,
"date_start": "2024-07-05T13:38:25+00:00",
"date_finish": "2024-07-05T13:38:25+00:00",
"operating_reset_at": 1720187305,
"operating": 0
}
}
```

150
docs/en/md/Bitrix24/Customs-tasks-fields-managment/Add-custom-task-field.md
View File

@ -1,75 +1,75 @@
---
sidebar_position: 2
---
# Add custom task field
Adds a new custom field to be added to the task
`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Type | --type | String | Field type: string, double, date, boolean |
| Name | --fieldname | String | Text identifier (name) of the field |
| ExternalID | --externalid | String | Text identifier for external integration |
| Title | --title | String | Field title |
| Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Type = "date";
Name = "BIRTHDAY_FIELD";
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Type = "string";
Name = "TEXT_FIELD";
ExternalID = "BITRIX_TEXT_FIELD";
Title = "Text field";
Signature = New Structure("en,ru", "Some field", "Nekotoroe pole");
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token);
```
```sh title="CLI command example"
oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token%
```
```json title="Result"
{
"result": 261,
"time": {
"start": 1722114794.52732,
"finish": 1722114794.59725,
"duration": 0.0699310302734375,
"processing": 0.0470340251922607,
"date_start": "2024-07-27T21:13:14+00:00",
"date_finish": "2024-07-27T21:13:14+00:00",
"operating_reset_at": 1722115394,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Add custom task field
Adds a new custom field to be added to the task
`Function AddCustomTaskField(Val URL, Val Type, Val Name, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Type | --type | String | Field type: string, double, date, boolean |
| Name | --fieldname | String | Text identifier (name) of the field |
| ExternalID | --externalid | String | Text identifier for external integration |
| Title | --title | String | Field title |
| Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Type = "date";
Name = "BIRTHDAY_FIELD";
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Type = "string";
Name = "TEXT_FIELD";
ExternalID = "BITRIX_TEXT_FIELD";
Title = "Text field";
Signature = New Structure("en,ru", "Some field", "Nekotoroe pole");
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name, ExternalID, Title, Signature, Token);
```
```sh title="CLI command example"
oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token%
```
```json title="Result"
{
"result": 261,
"time": {
"start": 1722114794.52732,
"finish": 1722114794.59725,
"duration": 0.0699310302734375,
"processing": 0.0470340251922607,
"date_start": "2024-07-27T21:13:14+00:00",
"date_finish": "2024-07-27T21:13:14+00:00",
"operating_reset_at": 1722115394,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Customs-tasks-fields-managment/Delete-custom-task-field.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 5
---
# Delete custom task field
Deletes a custom task field
`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for deletion |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FieldID = "255";
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FieldID = "257";
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, );
```
```sh title="CLI command example"
oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722114801.22925,
"finish": 1722114801.26696,
"duration": 0.0377130508422852,
"processing": 0.0185980796813965,
"date_start": "2024-07-27T21:13:21+00:00",
"date_finish": "2024-07-27T21:13:21+00:00",
"operating_reset_at": 1722115401,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Delete custom task field
Deletes a custom task field
`Function DeleteCustomTaskField(Val URL, Val FieldID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for deletion |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FieldID = "255";
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FieldID = "257";
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, );
```
```sh title="CLI command example"
oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722114801.22925,
"finish": 1722114801.26696,
"duration": 0.0377130508422852,
"processing": 0.0185980796813965,
"date_start": "2024-07-27T21:13:21+00:00",
"date_finish": "2024-07-27T21:13:21+00:00",
"operating_reset_at": 1722115401,
"operating": 0
}
}
```

372
docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-field.md
View File

@ -1,186 +1,186 @@
---
sidebar_position: 4
---
# Gets a custom task field
Get custom task field data
`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for retrieval |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FieldID = "255";
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FieldID = "257";
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID, );
```
```sh title="CLI command example"
oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```
```json title="Result"
{
"result": {
"ID": "261",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TEXT_FIELD",
"USER_TYPE_ID": "string",
"XML_ID": "NEW_TEXT_FIELD",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
},
"EDIT_FORM_LABEL": {
"ar": "",
"br": "",
"de": "",
"en": "Updated field",
"fr": "",
"id": "",
"it": "",
"ja": "",
"la": "",
"ms": "",
"pl": "",
"ru": "Izmenennoe pole",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"LIST_COLUMN_LABEL": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"LIST_FILTER_LABEL": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"ERROR_MESSAGE": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"HELP_MESSAGE": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
}
},
"total": 0,
"time": {
"start": 1722114797.9059,
"finish": 1722114797.92375,
"duration": 0.0178542137145996,
"processing": 0.000695943832397461,
"date_start": "2024-07-27T21:13:17+00:00",
"date_finish": "2024-07-27T21:13:17+00:00",
"operating_reset_at": 1722115397,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Gets a custom task field
Get custom task field data
`Function GetCustomTaskField(Val URL, Val FieldID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for retrieval |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FieldID = "255";
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FieldID = "257";
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID, );
```
```sh title="CLI command example"
oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```
```json title="Result"
{
"result": {
"ID": "261",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TEXT_FIELD",
"USER_TYPE_ID": "string",
"XML_ID": "NEW_TEXT_FIELD",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
},
"EDIT_FORM_LABEL": {
"ar": "",
"br": "",
"de": "",
"en": "Updated field",
"fr": "",
"id": "",
"it": "",
"ja": "",
"la": "",
"ms": "",
"pl": "",
"ru": "Izmenennoe pole",
"sc": "",
"tc": "",
"th": "",
"tr": "",
"ua": "",
"vn": ""
},
"LIST_COLUMN_LABEL": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"LIST_FILTER_LABEL": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"ERROR_MESSAGE": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
},
"HELP_MESSAGE": {
"ar": "Text field",
"br": "Text field",
"de": "Text field",
"en": "Text field",
"fr": "Text field",
"id": "Text field",
"it": "Text field",
"ja": "Text field",
"la": "Text field",
"ms": "Text field",
"pl": "Text field",
"ru": "Text field",
"sc": "Text field",
"tc": "Text field",
"th": "Text field",
"tr": "Text field",
"ua": "Text field",
"vn": "Text field"
}
},
"total": 0,
"time": {
"start": 1722114797.9059,
"finish": 1722114797.92375,
"duration": 0.0178542137145996,
"processing": 0.000695943832397461,
"date_start": "2024-07-27T21:13:17+00:00",
"date_finish": "2024-07-27T21:13:17+00:00",
"operating_reset_at": 1722115397,
"operating": 0
}
}
```

314
docs/en/md/Bitrix24/Customs-tasks-fields-managment/Get-custom-task-fields-list.md
View File

@ -1,157 +1,157 @@
---
sidebar_position: 1
---
# Get list of custom task fields
Gets list of custom task fields
`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
```
```sh title="CLI command example"
oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "11",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_CRM_TASK",
"USER_TYPE_ID": "crm",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"LEAD": "Y",
"CONTACT": "Y",
"COMPANY": "Y",
"DEAL": "Y",
"ORDER": "Y",
"SMART_INVOICE": "Y"
}
},
{
"ID": "101",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TASK_WEBDAV_FILES",
"USER_TYPE_ID": "disk_file",
"XML_ID": "TASK_WEBDAV_FILES",
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": []
},
{
"ID": "117",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_MAIL_MESSAGE",
"USER_TYPE_ID": "mail_message",
"XML_ID": "",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "N",
"IS_SEARCHABLE": "N",
"SETTINGS": []
},
{
"ID": "259",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_BIRTHDAY_FIELD",
"USER_TYPE_ID": "date",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"DEFAULT_VALUE": {
"TYPE": "NONE",
"VALUE": ""
}
}
},
{
"ID": "261",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TEXT_FIELD",
"USER_TYPE_ID": "string",
"XML_ID": "NEW_TEXT_FIELD",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
}
}
],
"total": 0,
"time": {
"start": 1722114799.57,
"finish": 1722114799.58769,
"duration": 0.0176839828491211,
"processing": 0.000379085540771484,
"date_start": "2024-07-27T21:13:19+00:00",
"date_finish": "2024-07-27T21:13:19+00:00",
"operating_reset_at": 1722115399,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Get list of custom task fields
Gets list of custom task fields
`Function GetCustomTaskFieldsList(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
```
```sh title="CLI command example"
oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "11",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_CRM_TASK",
"USER_TYPE_ID": "crm",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"LEAD": "Y",
"CONTACT": "Y",
"COMPANY": "Y",
"DEAL": "Y",
"ORDER": "Y",
"SMART_INVOICE": "Y"
}
},
{
"ID": "101",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TASK_WEBDAV_FILES",
"USER_TYPE_ID": "disk_file",
"XML_ID": "TASK_WEBDAV_FILES",
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": []
},
{
"ID": "117",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_MAIL_MESSAGE",
"USER_TYPE_ID": "mail_message",
"XML_ID": "",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "N",
"IS_SEARCHABLE": "N",
"SETTINGS": []
},
{
"ID": "259",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_BIRTHDAY_FIELD",
"USER_TYPE_ID": "date",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"DEFAULT_VALUE": {
"TYPE": "NONE",
"VALUE": ""
}
}
},
{
"ID": "261",
"ENTITY_ID": "TASKS_TASK",
"FIELD_NAME": "UF_TEXT_FIELD",
"USER_TYPE_ID": "string",
"XML_ID": "NEW_TEXT_FIELD",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"ROWS": 1,
"REGEXP": "",
"MIN_LENGTH": 0,
"MAX_LENGTH": 0,
"DEFAULT_VALUE": ""
}
}
],
"total": 0,
"time": {
"start": 1722114799.57,
"finish": 1722114799.58769,
"duration": 0.0176839828491211,
"processing": 0.000379085540771484,
"date_start": "2024-07-27T21:13:19+00:00",
"date_finish": "2024-07-27T21:13:19+00:00",
"operating_reset_at": 1722115399,
"operating": 0
}
}
```

144
docs/en/md/Bitrix24/Customs-tasks-fields-managment/Update-custom-task-field.md
View File

@ -1,72 +1,72 @@
---
sidebar_position: 3
---
# Update custom task field
Updates a custom task field data
`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for updating |
| ExternalID | --externalid | String | Text identifier for external integration |
| Title | --title | String | Field title |
| Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FieldID = "255";
Title = "New title";
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID,, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FieldID = "257";
ExternalID = "NEW_TEXT_FIELD";
Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole");
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID,, Signature, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722114796.23423,
"finish": 1722114796.26623,
"duration": 0.0319931507110596,
"processing": 0.0126721858978271,
"date_start": "2024-07-27T21:13:16+00:00",
"date_finish": "2024-07-27T21:13:16+00:00",
"operating_reset_at": 1722115396,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Update custom task field
Updates a custom task field data
`Function UpdateCustomTaskField(Val URL, Val FieldID, Val ExternalID = "", Val Title = "", Val Signature = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldID | --fieldid | String, Number | Field ID for updating |
| ExternalID | --externalid | String | Text identifier for external integration |
| Title | --title | String | Field title |
| Signature | --label | Structure of KeyAndValue | Form label. Key: en or ru, Value: Lable text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/userfield/update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FieldID = "255";
Title = "New title";
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID,, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FieldID = "257";
ExternalID = "NEW_TEXT_FIELD";
Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole");
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID, ExternalID,, Signature, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722114796.23423,
"finish": 1722114796.26623,
"duration": 0.0319931507110596,
"processing": 0.0126721858978271,
"date_start": "2024-07-27T21:13:16+00:00",
"date_finish": "2024-07-27T21:13:16+00:00",
"operating_reset_at": 1722115396,
"operating": 0
}
}
```

142
docs/en/md/Bitrix24/Departments-managment/Create-department.md
View File

@ -1,71 +1,71 @@
---
sidebar_position: 1
---
# Create department
Creates a new department
`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | Department name |
| ParentID | --parentid | String, Number | ID of parent department |
| HeadID | --headid | String, Number | ID of department manager |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Name = "Main department";
ParentID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Name = "Subordinate department";
ParentID = "68";
HeadID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": 42,
"time": {
"start": 1722171476.78229,
"finish": 1722171477.19809,
"duration": 0.415800094604492,
"processing": 0.389212131500244,
"date_start": "2024-07-28T12:57:56+00:00",
"date_finish": "2024-07-28T12:57:57+00:00",
"operating_reset_at": 1722172076,
"operating": 0.389190912246704
}
}
```
---
sidebar_position: 1
---
# Create department
Creates a new department
`Function CreateDepartment(Val URL, Val Name, Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | Department name |
| ParentID | --parentid | String, Number | ID of parent department |
| HeadID | --headid | String, Number | ID of department manager |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help/departments/department_add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Name = "Main department";
ParentID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Name = "Subordinate department";
ParentID = "68";
HeadID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": 42,
"time": {
"start": 1722171476.78229,
"finish": 1722171477.19809,
"duration": 0.415800094604492,
"processing": 0.389212131500244,
"date_start": "2024-07-28T12:57:56+00:00",
"date_finish": "2024-07-28T12:57:57+00:00",
"operating_reset_at": 1722172076,
"operating": 0.389190912246704
}
}
```

128
docs/en/md/Bitrix24/Departments-managment/Delete-department.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 4
---
# Delete department
Delets department by ID
`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Department ID for deletion |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
DepartmentID = "70";
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
DepartmentID = "68";
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722171482.56495,
"finish": 1722171482.65313,
"duration": 0.0881810188293457,
"processing": 0.0624208450317383,
"date_start": "2024-07-28T12:58:02+00:00",
"date_finish": "2024-07-28T12:58:02+00:00",
"operating_reset_at": 1722172082,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Delete department
Delets department by ID
`Function DeleteDepartment(Val URL, Val DepartmentID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Department ID for deletion |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_help/departments/department_delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
DepartmentID = "70";
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
DepartmentID = "68";
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722171482.56495,
"finish": 1722171482.65313,
"duration": 0.0881810188293457,
"processing": 0.0624208450317383,
"date_start": "2024-07-28T12:58:02+00:00",
"date_finish": "2024-07-28T12:58:02+00:00",
"operating_reset_at": 1722172082,
"operating": 0
}
}
```

152
docs/en/md/Bitrix24/Departments-managment/Get-departments.md
View File

@ -1,76 +1,76 @@
---
sidebar_position: 3
---
# Get departments
Gets a list of departments by ID or filter
`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Selection by department ID |
| Name | --title | String | Filter by name |
| ParentID | --parentid | String, Number | Filter by parent ID |
| HeadID | --headid | String, Number | Filter by manager ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
DepartmentID = "70";
Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
HeadID = 1;
Result = OPI_Bitrix24.GetDepartments(URL,,,, HeadID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "42",
"NAME": "Subordinate department",
"SORT": 500,
"PARENT": "40",
"UF_HEAD": "1"
}
],
"total": 1,
"time": {
"start": 1722171478.80371,
"finish": 1722171478.83794,
"duration": 0.034229040145874,
"processing": 0.00419092178344727,
"date_start": "2024-07-28T12:57:58+00:00",
"date_finish": "2024-07-28T12:57:58+00:00",
"operating_reset_at": 1722172078,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Get departments
Gets a list of departments by ID or filter
`Function GetDepartments(Val URL, Val DepartmentID = "", Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Selection by department ID |
| Name | --title | String | Filter by name |
| ParentID | --parentid | String, Number | Filter by parent ID |
| HeadID | --headid | String, Number | Filter by manager ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help/departments/department_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
DepartmentID = "70";
Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
HeadID = 1;
Result = OPI_Bitrix24.GetDepartments(URL,,,, HeadID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "42",
"NAME": "Subordinate department",
"SORT": 500,
"PARENT": "40",
"UF_HEAD": "1"
}
],
"total": 1,
"time": {
"start": 1722171478.80371,
"finish": 1722171478.83794,
"duration": 0.034229040145874,
"processing": 0.00419092178344727,
"date_start": "2024-07-28T12:57:58+00:00",
"date_finish": "2024-07-28T12:57:58+00:00",
"operating_reset_at": 1722172078,
"operating": 0
}
}
```

156
docs/en/md/Bitrix24/Departments-managment/Update-department.md
View File

@ -1,78 +1,78 @@
---
sidebar_position: 2
---
# Update department
Update an existing department
`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Department ID |
| Name | --title | String | Department name |
| ParentID | --parentid | String, Number | ID of parent department |
| HeadID | --headid | String, Number | ID of department manager |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
DepartmentID = "68";
ParentID = 7;
Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID,, ParentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
DepartmentID = "70";
Name = "New department";
ParentID = 1;
HeadID = 10;
Result = OPI_Bitrix24.UpdateDepartment(URL
, DepartmentID
, Name
, ParentID
, HeadID
, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722171480.45996,
"finish": 1722171480.83957,
"duration": 0.37961220741272,
"processing": 0.347241878509522,
"date_start": "2024-07-28T12:58:00+00:00",
"date_finish": "2024-07-28T12:58:00+00:00",
"operating_reset_at": 1722172080,
"operating": 0.34721302986145
}
}
```
---
sidebar_position: 2
---
# Update department
Update an existing department
`Function UpdateDepartment(Val URL, Val DepartmentID, Val Name = "", Val ParentID = "", Val HeadID = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| DepartmentID | --depid | String, Number | Department ID |
| Name | --title | String | Department name |
| ParentID | --parentid | String, Number | ID of parent department |
| HeadID | --headid | String, Number | ID of department manager |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_help/departments/department_update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
DepartmentID = "68";
ParentID = 7;
Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID,, ParentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
DepartmentID = "70";
Name = "New department";
ParentID = 1;
HeadID = 10;
Result = OPI_Bitrix24.UpdateDepartment(URL
, DepartmentID
, Name
, ParentID
, HeadID
, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722171480.45996,
"finish": 1722171480.83957,
"duration": 0.37961220741272,
"processing": 0.347241878509522,
"date_start": "2024-07-28T12:58:00+00:00",
"date_finish": "2024-07-28T12:58:00+00:00",
"operating_reset_at": 1722172080,
"operating": 0.34721302986145
}
}
```

132
docs/en/md/Bitrix24/Feed-posts-managment/Add-post-comment.md
View File

@ -1,66 +1,66 @@
---
sidebar_position: 6
---
# Add comment to post
Adds a comment to the post
`Function AddPostComment(Val URL, Val PostID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Post ID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php)
:::
<br/>
```bsl title="Code example"
Text = "Comment for post";
PostID = "440";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text);
Text = "Another comment";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 AddPostComment --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 168,
"time": {
"start": 1720186639.67208,
"finish": 1720186639.77202,
"duration": 0.0999400615692139,
"processing": 0.0715811252593994,
"date_start": "2024-07-05T13:37:19+00:00",
"date_finish": "2024-07-05T13:37:19+00:00",
"operating_reset_at": 1720187239,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Add comment to post
Adds a comment to the post
`Function AddPostComment(Val URL, Val PostID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Post ID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogcomment_add.php)
:::
<br/>
```bsl title="Code example"
Text = "Comment for post";
PostID = "440";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text);
Text = "Another comment";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 AddPostComment --url "b24-ar17wx.bitrix24.by" --postid "260" --text %text% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 168,
"time": {
"start": 1720186639.67208,
"finish": 1720186639.77202,
"duration": 0.0999400615692139,
"processing": 0.0715811252593994,
"date_start": "2024-07-05T13:37:19+00:00",
"date_finish": "2024-07-05T13:37:19+00:00",
"operating_reset_at": 1720187239,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/File-managment/Delete-file.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 4
---
# Delete file
Delete file by ID
`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | ID of removing file |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5008";
Result = OPI_Bitrix24.DeleteFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FileID = "5010";
Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFile --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718783933.86753,
"finish": 1718783937.64223,
"duration": 3.77469992637634,
"processing": 3.73617887496948,
"date_start": "2024-06-19T07:58:53+00:00",
"date_finish": "2024-06-19T07:58:57+00:00",
"operating_reset_at": 1718784533,
"operating": 3.73615193367004
}
}
```
---
sidebar_position: 4
---
# Delete file
Delete file by ID
`Function DeleteFile(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | ID of removing file |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5008";
Result = OPI_Bitrix24.DeleteFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
FileID = "5010";
Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFile --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718783933.86753,
"finish": 1718783937.64223,
"duration": 3.77469992637634,
"processing": 3.73617887496948,
"date_start": "2024-06-19T07:58:53+00:00",
"date_finish": "2024-06-19T07:58:57+00:00",
"operating_reset_at": 1718784533,
"operating": 3.73615193367004
}
}
```

126
docs/en/md/Bitrix24/File-managment/Get-file-external-link.md
View File

@ -1,63 +1,63 @@
---
sidebar_position: 5
---
# Get external link for a file
Get external link to file
`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFileExternalLink --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "https://b24-ar17wx.bitrix24.by/~pT3DD",
"time": {
"start": 1720017752.7023,
"finish": 1720017752.74417,
"duration": 0.0418639183044434,
"processing": 0.00636386871337891,
"date_start": "2024-07-03T14:42:32+00:00",
"date_finish": "2024-07-03T14:42:32+00:00",
"operating_reset_at": 1720018352,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Get external link for a file
Get external link to file
`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_getexternallink.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFileExternalLink --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "https://b24-ar17wx.bitrix24.by/~pT3DD",
"time": {
"start": 1720017752.7023,
"finish": 1720017752.74417,
"duration": 0.0418639183044434,
"processing": 0.00636386871337891,
"date_start": "2024-07-03T14:42:32+00:00",
"date_finish": "2024-07-03T14:42:32+00:00",
"operating_reset_at": 1720018352,
"operating": 0
}
}
```

164
docs/en/md/Bitrix24/File-managment/Get-file-information.md
View File

@ -1,82 +1,82 @@
---
sidebar_position: 3
---
# Get information about file
Get information about file by ID
`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.GetFileInformation(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFileInformation(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFileInformation --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "Picture1.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:28+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXJDbEFhcE51RG5ZZ0hwUVhJbXhybGRpUzhjbG82SHFO%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhKRGJFRmhjRTUxUkc1WlowaHdVVmhKYlhoeWJHUnBVemhqYkc4MlNIRk98ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.h344gCFe%2FeGei7hNDt%2FfG%2FqauSX2zpt%2BnX3KnR66llA%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg"
},
"time": {
"start": 1720017751.37945,
"finish": 1720017751.42512,
"duration": 0.0456681251525879,
"processing": 0.0131018161773682,
"date_start": "2024-07-03T14:42:31+00:00",
"date_finish": "2024-07-03T14:42:31+00:00",
"operating_reset_at": 1720018351,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Get information about file
Get information about file by ID
`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.GetFileInformation(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFileInformation(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFileInformation --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "Picture1.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:28+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXJDbEFhcE51RG5ZZ0hwUVhJbXhybGRpUzhjbG82SHFO%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhKRGJFRmhjRTUxUkc1WlowaHdVVmhKYlhoeWJHUnBVemhqYkc4MlNIRk98ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.h344gCFe%2FeGei7hNDt%2FfG%2FqauSX2zpt%2BnX3KnR66llA%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg"
},
"time": {
"start": 1720017751.37945,
"finish": 1720017751.42512,
"duration": 0.0456681251525879,
"processing": 0.0131018161773682,
"date_start": "2024-07-03T14:42:31+00:00",
"date_finish": "2024-07-03T14:42:31+00:00",
"operating_reset_at": 1720018351,
"operating": 0
}
}
```

178
docs/en/md/Bitrix24/File-managment/Make-file-copy.md
View File

@ -1,89 +1,89 @@
---
sidebar_position: 8
---
# Copy file
Copy file from one destination to another
`Function MakeFileCopy(Val URL, Val FileID, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | Original file ID |
| FolderID | --folderid | String, Number | ID of copy destination folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php)
:::
<br/>
```bsl title="Code example"
FolderID = "5014";
FileID = "5010";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID);
FolderID = "5016";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MakeFileCopy --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 1744,
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "1722",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 1146,
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:54+00:00",
"UPDATE_TIME": "2024-07-03T14:42:54+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0NCZfPWphdFBTRXpUdHI2anZKbDNxMDBwVTdRRVZ4aDdGVTMy%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBOQ1pmUFdwaGRGQlRSWHBVZEhJMmFuWktiRE54TURCd1ZUZFJSVlo0YURkR1ZUTXl8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.uOKd1v3hEnu7vsep0NhRk3RzXtyT21DBrrwPl3DxLG8%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg"
},
"time": {
"start": 1720017774.37632,
"finish": 1720017774.44715,
"duration": 0.07082200050354,
"processing": 0.0407531261444092,
"date_start": "2024-07-03T14:42:54+00:00",
"date_finish": "2024-07-03T14:42:54+00:00",
"operating_reset_at": 1720018374,
"operating": 0
}
}
```
---
sidebar_position: 8
---
# Copy file
Copy file from one destination to another
`Function MakeFileCopy(Val URL, Val FileID, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | Original file ID |
| FolderID | --folderid | String, Number | ID of copy destination folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_copyto.php)
:::
<br/>
```bsl title="Code example"
FolderID = "5014";
FileID = "5010";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID);
FolderID = "5016";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MakeFileCopy --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 1744,
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "1722",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 1146,
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:54+00:00",
"UPDATE_TIME": "2024-07-03T14:42:54+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0NCZfPWphdFBTRXpUdHI2anZKbDNxMDBwVTdRRVZ4aDdGVTMy%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBOQ1pmUFdwaGRGQlRSWHBVZEhJMmFuWktiRE54TURCd1ZUZFJSVlo0YURkR1ZUTXl8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.uOKd1v3hEnu7vsep0NhRk3RzXtyT21DBrrwPl3DxLG8%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New file name.jpg"
},
"time": {
"start": 1720017774.37632,
"finish": 1720017774.44715,
"duration": 0.07082200050354,
"processing": 0.0407531261444092,
"date_start": "2024-07-03T14:42:54+00:00",
"date_finish": "2024-07-03T14:42:54+00:00",
"operating_reset_at": 1720018374,
"operating": 0
}
}
```

164
docs/en/md/Bitrix24/File-managment/Mark-file-as-deleted.md
View File

@ -1,82 +1,82 @@
---
sidebar_position: 6
---
# Mark file as deleted
Move file to recycle bin
`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkFileAsDeleted --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "3",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:28+00:00",
"DELETE_TIME": "2024-07-03T14:42:34+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXNheWNTOWFZRVJuejdMOXhCSlhnbDZxbW4xVU05M1lK%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhOaGVXTlRPV0ZaUlZKdWVqZE1PWGhDU2xobmJEWnhiVzR4VlUwNU0xbEt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.H4kGiTtgZ%2BN0wWDCX0lKHQmfO9hOfINESfK6VVd1UJo%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpgi17200177547139i"
},
"time": {
"start": 1720017755.36075,
"finish": 1720017755.40426,
"duration": 0.0435140132904053,
"processing": 0.0109550952911377,
"date_start": "2024-07-03T14:42:35+00:00",
"date_finish": "2024-07-03T14:42:35+00:00",
"operating_reset_at": 1720018355,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Mark file as deleted
Move file to recycle bin
`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_markdeleted.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkFileAsDeleted --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "3",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:28+00:00",
"DELETE_TIME": "2024-07-03T14:42:34+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPXNheWNTOWFZRVJuejdMOXhCSlhnbDZxbW4xVU05M1lK%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFhOaGVXTlRPV0ZaUlZKdWVqZE1PWGhDU2xobmJEWnhiVzR4VlUwNU0xbEt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.H4kGiTtgZ%2BN0wWDCX0lKHQmfO9hOfINESfK6VVd1UJo%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpgi17200177547139i"
},
"time": {
"start": 1720017755.36075,
"finish": 1720017755.40426,
"duration": 0.0435140132904053,
"processing": 0.0109550952911377,
"date_start": "2024-07-03T14:42:35+00:00",
"date_finish": "2024-07-03T14:42:35+00:00",
"operating_reset_at": 1720018355,
"operating": 0
}
}
```

178
docs/en/md/Bitrix24/File-managment/Move-file-to-folder.md
View File

@ -1,89 +1,89 @@
---
sidebar_position: 9
---
# Move file
Move file from one destination to another
`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File ID |
| FolderID | --folderid | String, Number | ID of new destination folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php)
:::
<br/>
```bsl title="Code example"
FolderID = "5018";
FileID = "5010";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID);
FolderID = "5020";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MoveFileToFolder --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": 1726,
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:36+00:00",
"DELETE_TIME": "2024-07-03T14:42:34+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPUtKOGRTc3BCNmFoWDN3bjdXVVJzV2FEbWdrOXNOQk5K%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFV0S09HUlRjM0JDTm1Gb1dETjNiamRYVlZKelYyRkViV2RyT1hOT1FrNUt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.TUnzDUP0VCd8GRkzGSamf6aYWKIRqoB9Fpi6xFrBwBA%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New subfolder/New file name.jpg"
},
"time": {
"start": 1720017764.56434,
"finish": 1720017764.63176,
"duration": 0.0674228668212891,
"processing": 0.0307409763336182,
"date_start": "2024-07-03T14:42:44+00:00",
"date_finish": "2024-07-03T14:42:44+00:00",
"operating_reset_at": 1720018364,
"operating": 0
}
}
```
---
sidebar_position: 9
---
# Move file
Move file from one destination to another
`Function MoveFileToFolder(Val URL, Val FileID, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File ID |
| FolderID | --folderid | String, Number | ID of new destination folder |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_moveto.php)
:::
<br/>
```bsl title="Code example"
FolderID = "5018";
FileID = "5010";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID);
FolderID = "5020";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token);
Check_BitrixObject(Result);
```
```sh title="CLI command example"
oint bitrix24 MoveFileToFolder --url "b24-ar17wx.bitrix24.by" --fileid "2484" --folderid "2494" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": 1726,
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:36+00:00",
"DELETE_TIME": "2024-07-03T14:42:34+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPUtKOGRTc3BCNmFoWDN3bjdXVVJzV2FEbWdrOXNOQk5K%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFV0S09HUlRjM0JDTm1Gb1dETjNiamRYVlZKelYyRkViV2RyT1hOT1FrNUt8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.TUnzDUP0VCd8GRkzGSamf6aYWKIRqoB9Fpi6xFrBwBA%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/New subfolder/New file name.jpg"
},
"time": {
"start": 1720017764.56434,
"finish": 1720017764.63176,
"duration": 0.0674228668212891,
"processing": 0.0307409763336182,
"date_start": "2024-07-03T14:42:44+00:00",
"date_finish": "2024-07-03T14:42:44+00:00",
"operating_reset_at": 1720018364,
"operating": 0
}
}
```

174
docs/en/md/Bitrix24/File-managment/Rename-file.md
View File

@ -1,87 +1,87 @@
---
sidebar_position: 10
---
# Rename file
Changes the name of an existing file
`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Name | --title | String | New folders name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php)
:::
<br/>
```bsl title="Code example"
Name = "New file name.jpg";
Filename2 = "New file name 2.jpg";
FileID2 = "5008";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2);
FileID = "5010";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:28+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWh4MGZDaVNISklmakNDZ2VDQnBGQ25oaWhnUzRVaVNG%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdoNE1HWkRhVk5JU2tsbWFrTkRaMlZEUW5CR1EyNW9hV2huVXpSVmFWTkd8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.I5xOjqhubMfxDzA0AHzUE5AzgUeXOOmA4%2FsEKdiUSyQ%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg"
},
"time": {
"start": 1720017754.0472,
"finish": 1720017754.09402,
"duration": 0.0468170642852783,
"processing": 0.0171689987182617,
"date_start": "2024-07-03T14:42:34+00:00",
"date_finish": "2024-07-03T14:42:34+00:00",
"operating_reset_at": 1720018354,
"operating": 0
}
}
```
---
sidebar_position: 10
---
# Rename file
Changes the name of an existing file
`Function RenameFile(Val URL, Val FileID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Name | --title | String | New folders name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_rename.php)
:::
<br/>
```bsl title="Code example"
Name = "New file name.jpg";
Filename2 = "New file name 2.jpg";
FileID2 = "5008";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2);
FileID = "5010";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenameFile(URL, FileID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --title %title% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:28+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWh4MGZDaVNISklmakNDZ2VDQnBGQ25oaWhnUzRVaVNG%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdoNE1HWkRhVk5JU2tsbWFrTkRaMlZEUW5CR1EyNW9hV2huVXpSVmFWTkd8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.I5xOjqhubMfxDzA0AHzUE5AzgUeXOOmA4%2FsEKdiUSyQ%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg"
},
"time": {
"start": 1720017754.0472,
"finish": 1720017754.09402,
"duration": 0.0468170642852783,
"processing": 0.0171689987182617,
"date_start": "2024-07-03T14:42:34+00:00",
"date_finish": "2024-07-03T14:42:34+00:00",
"operating_reset_at": 1720018354,
"operating": 0
}
}
```

164
docs/en/md/Bitrix24/File-managment/Restore-file.md
View File

@ -1,82 +1,82 @@
---
sidebar_position: 7
---
# Restore file
Restore file from recycle bin
`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.RestoreFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RestoreFile(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 RestoreFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:36+00:00",
"DELETE_TIME": "2024-07-03T14:42:34+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWs2c1VzV3l4ZkVmRG5PY1JYSGdibHNxZzJ1S2pGbDNC%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdzMmMxVnpWM2w0WmtWbVJHNVBZMUpZU0dkaWJITnhaekoxUzJwR2JETkN8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.iv0WpvLa68S5kviQk96g9dRPVonwvrxN7T6AunrAW9s%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg"
},
"time": {
"start": 1720017756.65038,
"finish": 1720017756.69349,
"duration": 0.0431070327758789,
"processing": 0.0107128620147705,
"date_start": "2024-07-03T14:42:36+00:00",
"date_finish": "2024-07-03T14:42:36+00:00",
"operating_reset_at": 1720018356,
"operating": 0
}
}
```
---
sidebar_position: 7
---
# Restore file
Restore file from recycle bin
`Function RestoreFile(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_help/disk/file/disk_file_restore.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
FileID = "5010";
Result = OPI_Bitrix24.RestoreFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RestoreFile(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 RestoreFile --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "1716",
"NAME": "New file name.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "1134",
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:28+00:00",
"UPDATE_TIME": "2024-07-03T14:42:36+00:00",
"DELETE_TIME": "2024-07-03T14:42:34+00:00",
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "1",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTcxNiZfPWs2c1VzV3l4ZkVmRG5PY1JYSGdibHNxZzJ1S2pGbDNC%7CImRvd25sb2FkfGRpc2t8YVdROU1UY3hOaVpmUFdzMmMxVnpWM2w0WmtWbVJHNVBZMUpZU0dkaWJITnhaekoxUzJwR2JETkN8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.iv0WpvLa68S5kviQk96g9dRPVonwvrxN7T6AunrAW9s%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New file name.jpg"
},
"time": {
"start": 1720017756.65038,
"finish": 1720017756.69349,
"duration": 0.0431070327758789,
"processing": 0.0107128620147705,
"date_start": "2024-07-03T14:42:36+00:00",
"date_finish": "2024-07-03T14:42:36+00:00",
"operating_reset_at": 1720018356,
"operating": 0
}
}
```

162
docs/en/md/Bitrix24/File-managment/Upload-file-to-folder.md
View File

@ -1,81 +1,81 @@
---
sidebar_position: 2
---
# Upload file to the folder
Upload local file to the folder
`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | File name with extension |
| File | --file | String, BinaryData | File for upload |
| FolderID | --folderid | String | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php)
:::
<br/>
```bsl title="Code example"
Filename2 = "Picture2.jpg";
Name = "Picture1.jpg";
Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data
Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data
DestinationID = "5016";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UploadFileToFolder(URL, Name, Image, DestinationID, Token);
```
```sh title="CLI command example"
oint bitrix24 UploadFileToFolder --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 1740,
"NAME": "Picture1.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "1722",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 1142,
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:52+00:00",
"UPDATE_TIME": "2024-07-03T14:42:52+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0MCZfPTFqN3RzcGx4UndmRkk0cmlvVGVFQUEzQ05lOHZ0U1RR%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBNQ1pmUFRGcU4zUnpjR3g0VW5kbVJrazBjbWx2VkdWRlFVRXpRMDVsT0haMFUxUlJ8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.yWcwutXSoxydbwTQ7d1Aapgpo69Iyc2LhhtmuH442Uo%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/Picture1.jpg"
}
}
```
---
sidebar_position: 2
---
# Upload file to the folder
Upload local file to the folder
`Function UploadFileToFolder(Val URL, Val Name, Val File, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | File name with extension |
| File | --file | String, BinaryData | File for upload |
| FolderID | --folderid | String | Folder identifier |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/folder/disk_folder_uploadfile.php)
:::
<br/>
```bsl title="Code example"
Filename2 = "Picture2.jpg";
Name = "Picture1.jpg";
Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data
Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data
DestinationID = "5016";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.UploadFileToFolder(URL, Filename2, Image2, DestinationID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UploadFileToFolder(URL, Name, Image, DestinationID, Token);
```
```sh title="CLI command example"
oint bitrix24 UploadFileToFolder --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --folderid %folderid% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 1740,
"NAME": "Picture1.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "1722",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 1142,
"SIZE": "805189",
"CREATE_TIME": "2024-07-03T14:42:52+00:00",
"UPDATE_TIME": "2024-07-03T14:42:52+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=fe708566006e9f06006b12e4000000010000076fcba303ea853529aed2cefade1444b3&token=disk%7CaWQ9MTc0MCZfPTFqN3RzcGx4UndmRkk0cmlvVGVFQUEzQ05lOHZ0U1RR%7CImRvd25sb2FkfGRpc2t8YVdROU1UYzBNQ1pmUFRGcU4zUnpjR3g0VW5kbVJrazBjbWx2VkdWRlFVRXpRMDVsT0haMFUxUlJ8ZmU3MDg1NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDc2ZmNiYTMwM2VhODUzNTI5YWVkMmNlZmFkZTE0NDRiMyI%3D.yWcwutXSoxydbwTQ7d1Aapgpo69Iyc2LhhtmuH442Uo%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/New catalog/Picture1.jpg"
}
}
```

184
docs/en/md/Bitrix24/File-managment/Upload-file-to-storage.md
View File

@ -1,92 +1,92 @@
---
sidebar_position: 1
---
# Upload file to a storage
Upload file to storage root
`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | File name with extension |
| File | --file | String, BinaryData | File for upload |
| StorageID | --storageid | String | Storage id |
| Rights | --rights | String | Rights array if required |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php)
:::
<br/>
```bsl title="Code example"
Filename2 = "Picture2.jpg";
Name = "Picture1.jpg";
Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data
Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data
DestinationID = 3;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token);
```
```sh title="CLI command example"
oint bitrix24 UploadFileToStorage --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 356,
"NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 404,
"SIZE": "26",
"CREATE_TIME": "2024-06-19T07:58:50+00:00",
"UPDATE_TIME": "2024-06-19T07:58:50+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg"
},
"time": {
"start": 1718783929.8197,
"finish": 1718783930.09911,
"duration": 0.279407024383545,
"processing": 0.227760076522827,
"date_start": "2024-06-19T07:58:49+00:00",
"date_finish": "2024-06-19T07:58:50+00:00",
"operating_reset_at": 1718784529,
"operating": 0.227726936340332
}
}
```
---
sidebar_position: 1
---
# Upload file to a storage
Upload file to storage root
`Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | File name with extension |
| File | --file | String, BinaryData | File for upload |
| StorageID | --storageid | String | Storage id |
| Rights | --rights | String | Rights array if required |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_uploadfile.php)
:::
<br/>
```bsl title="Code example"
Filename2 = "Picture2.jpg";
Name = "Picture1.jpg";
Image2 = "https://openintegrations.dev/test_data/picture.jpg"; // Local path, URL or Binary Data
Image = "https://openintegrations.dev/test_data/picture2.jpg"; // Local path, URL or Binary Data
DestinationID = 3;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.UploadFileToStorage(URL, Filename2, Image2, DestinationID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token);
```
```sh title="CLI command example"
oint bitrix24 UploadFileToStorage --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 356,
"NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 404,
"SIZE": "26",
"CREATE_TIME": "2024-06-19T07:58:50+00:00",
"UPDATE_TIME": "2024-06-19T07:58:50+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=0a9d7266006e9f06006b12e40000000100000702aaae0c0e99153466d165ecfa4a92ce&token=disk%7CaWQ9MzU2Jl89TEZ6d3JtUDdUdVg0dXJ3Q2pZYTExTlhPTmh1czI3V1k%3D%7CImRvd25sb2FkfGRpc2t8YVdROU16VTJKbDg5VEVaNmQzSnRVRGRVZFZnMGRYSjNRMnBaWVRFeFRsaFBUbWgxY3pJM1Yxaz18MGE5ZDcyNjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDcwMmFhYWUwYzBlOTkxNTM0NjZkMTY1ZWNmYTRhOTJjZSI%3D.ng9IaX1mYX7R%2B4yWP67P6j9%2BWvh78aG47IO0Ex6UVQ8%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/26417397-8431-4343-9c0f-a40d4a2831c8.jpg"
},
"time": {
"start": 1718783929.8197,
"finish": 1718783930.09911,
"duration": 0.279407024383545,
"processing": 0.227760076522827,
"date_start": "2024-06-19T07:58:49+00:00",
"date_finish": "2024-06-19T07:58:50+00:00",
"operating_reset_at": 1718784529,
"operating": 0.227726936340332
}
}
```

148
docs/en/md/Bitrix24/Kanban/Add-kanban-stage.md
View File

@ -1,74 +1,74 @@
---
sidebar_position: 1
---
# Add kanban stage
Add new stage of kanban or My Plan
`Function AddKanbanStage(Val URL, Val Name, Val Color = "FFD800", Val PrevStageID = 0, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | New stage name |
| Color | --color | String | HEX of new stage color |
| PrevStageID | --prevstage | String, Number | ID of the stage after which a new stage should be inserted (at the beginning by default.) |
| EntityID | --entityid | String, Number | ID of kanban owner (group or user) |
| AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php)
:::
<br/>
```bsl title="Code example"
Name = "New stage";
Color = "0026FF";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6);
PrevStageID = Result["result"];
Name = "New stage 2";
Color = "0026FF";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, PrevStageID,, True, Token);
```
```sh title="CLI command example"
oint bitrix24 AddKanbanStage --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 132,
"time": {
"start": 1720600360.58899,
"finish": 1720600360.679,
"duration": 0.0900149345397949,
"processing": 0.0587739944458008,
"date_start": "2024-07-10T08:32:40+00:00",
"date_finish": "2024-07-10T08:32:40+00:00",
"operating_reset_at": 1720600960,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Add kanban stage
Add new stage of kanban or My Plan
`Function AddKanbanStage(Val URL, Val Name, Val Color = "FFD800", Val PrevStageID = 0, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | New stage name |
| Color | --color | String | HEX of new stage color |
| PrevStageID | --prevstage | String, Number | ID of the stage after which a new stage should be inserted (at the beginning by default.) |
| EntityID | --entityid | String, Number | ID of kanban owner (group or user) |
| AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_add.php)
:::
<br/>
```bsl title="Code example"
Name = "New stage";
Color = "0026FF";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, 6);
PrevStageID = Result["result"];
Name = "New stage 2";
Color = "0026FF";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.AddKanbanStage(URL, Name, Color, PrevStageID,, True, Token);
```
```sh title="CLI command example"
oint bitrix24 AddKanbanStage --url "b24-ar17wx.bitrix24.by" --title %title% --color %color% --prevstage %prevstage% --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 132,
"time": {
"start": 1720600360.58899,
"finish": 1720600360.679,
"duration": 0.0900149345397949,
"processing": 0.0587739944458008,
"date_start": "2024-07-10T08:32:40+00:00",
"date_finish": "2024-07-10T08:32:40+00:00",
"operating_reset_at": 1720600960,
"operating": 0
}
}
```

134
docs/en/md/Bitrix24/Kanban/Delete-kanban-stage.md
View File

@ -1,67 +1,67 @@
---
sidebar_position: 3
---
# ID of the stage to be deleted
Removes a kanban (My Plan) stage, provided there are no tasks in it
`Function DeleteKanbanStage(Val URL, Val StageID, Val AsAdmin = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StageID | --stage | String, Number | ID of stage to dele |
| AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php)
:::
<br/>
```bsl title="Code example"
StageID = "318";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True);
StageID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID,, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteKanbanStage --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720600367.83205,
"finish": 1720600367.8709,
"duration": 0.0388522148132324,
"processing": 0.0057981014251709,
"date_start": "2024-07-10T08:32:47+00:00",
"date_finish": "2024-07-10T08:32:47+00:00",
"operating_reset_at": 1720600967,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# ID of the stage to be deleted
Removes a kanban (My Plan) stage, provided there are no tasks in it
`Function DeleteKanbanStage(Val URL, Val StageID, Val AsAdmin = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StageID | --stage | String, Number | ID of stage to dele |
| AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_delete.php)
:::
<br/>
```bsl title="Code example"
StageID = "318";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True);
StageID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID,, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteKanbanStage --url "b24-ar17wx.bitrix24.by" --stage "128" --admin %admin% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720600367.83205,
"finish": 1720600367.8709,
"duration": 0.0388522148132324,
"processing": 0.0057981014251709,
"date_start": "2024-07-10T08:32:47+00:00",
"date_finish": "2024-07-10T08:32:47+00:00",
"operating_reset_at": 1720600967,
"operating": 0
}
}
```

1112
docs/en/md/Bitrix24/Kanban/Get-kanban-stages.md
View File

File diff suppressed because it is too large Load Diff

140
docs/en/md/Bitrix24/Kanban/Move-task-to-kanban-stage.md
View File

@ -1,70 +1,70 @@
---
sidebar_position: 5
---
# Move task to kanban stage
Move task to another kanban stage
`Function MoveTaskToKanbanStage(Val URL, Val TaskID, Val StageID, Val Prev = 0, Val After = 0, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | String, Number | ID of task to move |
| StageID | --stage | String, Number | Stage ID |
| Prev | --before | String, Number | ID of the task to put the selected one in front of (if After not filled) |
| After | --after | String, Number | ID of the task to be followed by the selected (if Prev not filled) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php)
:::
<br/>
```bsl title="Code example"
TaskID = "1086";
StageID = "318";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID);
StageID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID,,, Token);
```
```sh title="CLI command example"
oint bitrix24 MoveTaskToKanbanStage --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720600364.06058,
"finish": 1720600364.11507,
"duration": 0.0544910430908203,
"processing": 0.0175719261169434,
"date_start": "2024-07-10T08:32:44+00:00",
"date_finish": "2024-07-10T08:32:44+00:00",
"operating_reset_at": 1720600964,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Move task to kanban stage
Move task to another kanban stage
`Function MoveTaskToKanbanStage(Val URL, Val TaskID, Val StageID, Val Prev = 0, Val After = 0, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | String, Number | ID of task to move |
| StageID | --stage | String, Number | Stage ID |
| Prev | --before | String, Number | ID of the task to put the selected one in front of (if After not filled) |
| After | --after | String, Number | ID of the task to be followed by the selected (if Prev not filled) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_movetask.php)
:::
<br/>
```bsl title="Code example"
TaskID = "1086";
StageID = "318";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID);
StageID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID,,, Token);
```
```sh title="CLI command example"
oint bitrix24 MoveTaskToKanbanStage --url "b24-ar17wx.bitrix24.by" --task "528" --stage "128" --before %before% --after %after% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720600364.06058,
"finish": 1720600364.11507,
"duration": 0.0544910430908203,
"processing": 0.0175719261169434,
"date_start": "2024-07-10T08:32:44+00:00",
"date_finish": "2024-07-10T08:32:44+00:00",
"operating_reset_at": 1720600964,
"operating": 0
}
}
```

148
docs/en/md/Bitrix24/Kanban/Update-kanbans-stage.md
View File

@ -1,74 +1,74 @@
---
sidebar_position: 2
---
# Change kanban stage
Changes the properties of the existing kanban or My plan stage
`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | New stages name |
| StageID | --stage | String, Number | Stage ID for change |
| Color | --color | String | HEX of new stage color |
| PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted |
| AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php)
:::
<br/>
```bsl title="Code example"
Name = "New stage name";
Color = "000000";
StageID = "318";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color);
Name = "New stage name 2";
Color = "000000";
StageID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateKanbansStage --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816577.57757,
"finish": 1720816577.66624,
"duration": 0.0886678695678711,
"processing": 0.059006929397583,
"date_start": "2024-07-12T20:36:17+00:00",
"date_finish": "2024-07-12T20:36:17+00:00",
"operating_reset_at": 1720817177,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Change kanban stage
Changes the properties of the existing kanban or My plan stage
`Function UpdateKanbansStage(Val URL, Val Name, Val StageID, Val Color = "", Val PrevStageID = 0, Val AsAdmin = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Name | --title | String | New stages name |
| StageID | --stage | String, Number | Stage ID for change |
| Color | --color | String | HEX of new stage color |
| PrevStageID | --prevstage | String, Number | Stage ID, after which the selected stage should be inserted |
| AsAdmin | --admin | Boolean | Allows you to add stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/kanban/task_stages_update.php)
:::
<br/>
```bsl title="Code example"
Name = "New stage name";
Color = "000000";
StageID = "318";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color);
Name = "New stage name 2";
Color = "000000";
StageID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color, 6, True, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateKanbansStage --url %url% --title %title% --stage %stage% --color %color% --prevstage %prevstage% --admin %admin% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816577.57757,
"finish": 1720816577.66624,
"duration": 0.0886678695678711,
"processing": 0.059006929397583,
"date_start": "2024-07-12T20:36:17+00:00",
"date_finish": "2024-07-12T20:36:17+00:00",
"operating_reset_at": 1720817177,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Message-management/Delete-message.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 4
---
# Delete message
Deletes a dialog message
`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| MessageID | --message | String, Number | ID of the message to be deleted |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
MessageID = "8682";
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
MessageID = "8684";
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteMessage --url %url% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969167.77137,
"finish": 1720969167.82331,
"duration": 0.051936149597168,
"processing": 0.0215229988098145,
"date_start": "2024-07-14T14:59:27+00:00",
"date_finish": "2024-07-14T14:59:27+00:00",
"operating_reset_at": 1720969767,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Delete message
Deletes a dialog message
`Function DeleteMessage(Val URL, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| MessageID | --message | String, Number | ID of the message to be deleted |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12119)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
MessageID = "8682";
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
MessageID = "8684";
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteMessage --url %url% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969167.77137,
"finish": 1720969167.82331,
"duration": 0.051936149597168,
"processing": 0.0215229988098145,
"date_start": "2024-07-14T14:59:27+00:00",
"date_finish": "2024-07-14T14:59:27+00:00",
"operating_reset_at": 1720969767,
"operating": 0
}
}
```

150
docs/en/md/Bitrix24/Message-management/Edit-message.md
View File

@ -1,75 +1,75 @@
---
sidebar_position: 2
---
# Edit message
Edit dialog message content
`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| MessageID | --message | String, Number | ID of the message to be edited |
| Text | --text | String | New message text |
| Attachments | --blocks | Array of Structure | New blocks array |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
MessageID = "8682";
Text = "New message text";
Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
MessageID = "8684";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token);
```
```sh title="CLI command example"
oint bitrix24 EditMessage --url %url% --message %message% --text %text% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969165.17314,
"finish": 1720969165.21621,
"duration": 0.0430619716644287,
"processing": 0.018265962600708,
"date_start": "2024-07-14T14:59:25+00:00",
"date_finish": "2024-07-14T14:59:25+00:00",
"operating_reset_at": 1720969765,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Edit message
Edit dialog message content
`Function EditMessage(Val URL, Val MessageID, Val Text = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| MessageID | --message | String, Number | ID of the message to be edited |
| Text | --text | String | New message text |
| Attachments | --blocks | Array of Structure | New blocks array |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12117)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
MessageID = "8682";
Text = "New message text";
Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
MessageID = "8684";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text, Attachments, Token);
```
```sh title="CLI command example"
oint bitrix24 EditMessage --url %url% --message %message% --text %text% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969165.17314,
"finish": 1720969165.21621,
"duration": 0.0430619716644287,
"processing": 0.018265962600708,
"date_start": "2024-07-14T14:59:25+00:00",
"date_finish": "2024-07-14T14:59:25+00:00",
"operating_reset_at": 1720969765,
"operating": 0
}
}
```

74
docs/en/md/Bitrix24/Message-management/Get-file-block.md
View File

@ -1,37 +1,37 @@
---
sidebar_position: 9
---
# Get file block
Make file block for SendMessage method
`Function GetFileBlock(Val Name, Val URL) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Picture name |
| URL | --url | String | File URL |
Returns: Structure - FileBlock
<br/>
:::tip
Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867)
:::
<br/>
```sh title="CLI command example"
oint bitrix24 GetFileBlock --title %title% --url %url%
```
---
sidebar_position: 9
---
# Get file block
Make file block for SendMessage method
`Function GetFileBlock(Val Name, Val URL) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Picture name |
| URL | --url | String | File URL |
Returns: Structure - FileBlock
<br/>
:::tip
Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867)
:::
<br/>
```sh title="CLI command example"
oint bitrix24 GetFileBlock --title %title% --url %url%
```

74
docs/en/md/Bitrix24/Message-management/Get-picture-block.md
View File

@ -1,37 +1,37 @@
---
sidebar_position: 8
---
# Get picture block
Make picture block for SendMessage method
`Function GetPictureBlock(Val Name, Val URL) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Picture name |
| URL | --url | String | URL of sending picture |
Returns: Structure - PictureBlock
<br/>
:::tip
Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867)
:::
<br/>
```sh title="CLI command example"
oint bitrix24 GetPictureBlock --title %title% --url %url%
```
---
sidebar_position: 8
---
# Get picture block
Make picture block for SendMessage method
`Function GetPictureBlock(Val Name, Val URL) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Name | --title | String | Picture name |
| URL | --url | String | URL of sending picture |
Returns: Structure - PictureBlock
<br/>
:::tip
Blocks at API documentation: [Link](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&CHAPTER_ID=07867)
:::
<br/>
```sh title="CLI command example"
oint bitrix24 GetPictureBlock --title %title% --url %url%
```

144
docs/en/md/Bitrix24/Message-management/Mark-message-as-readed.md
View File

@ -1,72 +1,72 @@
---
sidebar_position: 6
---
# Mark message as readed
Mark current and all previous messages as readed
`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| MessageID | --message | String, Number | Id of last readed message |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
MessageID = "8682";
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
MessageID = "8684";
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkMessageAsReaded --url %url% --chat %chat% --message %message% --token %token%
```
```json title="Result"
{
"result": {
"dialogId": 10,
"chatId": 10,
"lastId": 5262,
"counter": 0
},
"time": {
"start": 1720969157.61149,
"finish": 1720969157.65659,
"duration": 0.0451040267944336,
"processing": 0.0171201229095459,
"date_start": "2024-07-14T14:59:17+00:00",
"date_finish": "2024-07-14T14:59:17+00:00",
"operating_reset_at": 1720969757,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Mark message as readed
Mark current and all previous messages as readed
`Function MarkMessageAsReaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| MessageID | --message | String, Number | Id of last readed message |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12053)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
MessageID = "8682";
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
MessageID = "8684";
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkMessageAsReaded --url %url% --chat %chat% --message %message% --token %token%
```
```json title="Result"
{
"result": {
"dialogId": 10,
"chatId": 10,
"lastId": 5262,
"counter": 0
},
"time": {
"start": 1720969157.61149,
"finish": 1720969157.65659,
"duration": 0.0451040267944336,
"processing": 0.0171201229095459,
"date_start": "2024-07-14T14:59:17+00:00",
"date_finish": "2024-07-14T14:59:17+00:00",
"operating_reset_at": 1720969757,
"operating": 0
}
}
```

134
docs/en/md/Bitrix24/Message-management/Mark-message-as-unreaded.md
View File

@ -1,67 +1,67 @@
---
sidebar_position: 7
---
# Mark message as unreaded
Mark current and all messages after as unreaded
`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| MessageID | --message | String, Number | ID of last unreaded message |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
MessageID = "8682";
Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
MessageID = "8684";
Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkMessageAsUnreaded --url %url% --chat %chat% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969158.8803,
"finish": 1720969158.91584,
"duration": 0.035538911819458,
"processing": 0.0112378597259521,
"date_start": "2024-07-14T14:59:18+00:00",
"date_finish": "2024-07-14T14:59:18+00:00",
"operating_reset_at": 1720969758,
"operating": 0
}
}
```
---
sidebar_position: 7
---
# Mark message as unreaded
Mark current and all messages after as unreaded
`Function MarkMessageAsUnreaded(Val URL, Val ChatID, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| MessageID | --message | String, Number | ID of last unreaded message |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12055)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
MessageID = "8682";
Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
MessageID = "8684";
Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, UserID, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 MarkMessageAsUnreaded --url %url% --chat %chat% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969158.8803,
"finish": 1720969158.91584,
"duration": 0.035538911819458,
"processing": 0.0112378597259521,
"date_start": "2024-07-14T14:59:18+00:00",
"date_finish": "2024-07-14T14:59:18+00:00",
"operating_reset_at": 1720969758,
"operating": 0
}
}
```

286
docs/en/md/Bitrix24/Message-management/Send-file.md
View File

@ -1,143 +1,143 @@
---
sidebar_position: 5
---
# Send file
Send disk file to chat
`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| FileID | --fileid | String, Number | File ID from UploadFileToFolder method |
| Description | --description | String | File description |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
File = "https://openintegrations.dev/test_data/document.docx"; // Binary Data, URL or path to file
Description = "Very important file";
Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
FolderID = Directory["result"]["ID"];
UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID);
FileID = UploadedFile["result"]["ID"];
Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token);
FolderID = Directory["result"]["ID"];
UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token);
FileID = UploadedFile["result"]["ID"];
Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token);
```
```sh title="CLI command example"
oint bitrix24 SendFile --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token%
```
```json title="Result"
{
"result": {
"FILES": {
"upload3254": {
"id": 3254,
"chatId": 254,
"date": {},
"type": "file",
"name": "Imortant doc.docx",
"extension": "docx",
"size": 24071,
"image": false,
"status": "done",
"progress": 100,
"authorId": 1,
"authorName": "Anton Titovets",
"urlPreview": "",
"urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"viewerAttrs": {
"viewer": null,
"viewerType": "cloud-document",
"src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem",
"viewerSeparateItem": true,
"viewerExtension": "im.integration.viewer",
"objectId": "3254",
"imChatId": 254,
"title": "Imortant doc.docx",
"actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Save to Bitrix24 Drive\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]"
}
}
},
"DISK_ID": [
"3254"
],
"FILE_MODELS": {
"upload3254": {
"id": 3254,
"name": "Imortant doc.docx",
"createTime": {},
"updateTime": {},
"deleteTime": null,
"code": null,
"xmlId": null,
"storageId": 6,
"realObjectId": 3254,
"parentId": 3250,
"deletedType": 0,
"createdBy": "1",
"updatedBy": "1",
"deletedBy": "0",
"typeFile": 4,
"globalContentVersion": 2,
"fileId": 2330,
"size": 24071,
"etag": "1179305ea90d0b0fef106e1163deaeb8",
"links": {
"download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254",
"showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1"
}
}
},
"MESSAGE_ID": 5346
},
"time": {
"start": 1720969175.0006,
"finish": 1720969175.09084,
"duration": 0.0902431011199951,
"processing": 0.0652461051940918,
"date_start": "2024-07-14T14:59:35+00:00",
"date_finish": "2024-07-14T14:59:35+00:00",
"operating_reset_at": 1720969775,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Send file
Send disk file to chat
`Function SendFile(Val URL, Val ChatID, Val FileID, Val Description = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID |
| FileID | --fileid | String, Number | File ID from UploadFileToFolder method |
| Description | --description | String | File description |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11485)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
File = "https://openintegrations.dev/test_data/document.docx"; // Binary Data, URL or path to file
Description = "Very important file";
Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
FolderID = Directory["result"]["ID"];
UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID);
FileID = UploadedFile["result"]["ID"];
Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Directory = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID, Token);
FolderID = Directory["result"]["ID"];
UploadedFile = OPI_Bitrix24.UploadFileToFolder(URL, "Imortant doc.docx", File, FolderID, Token);
FileID = UploadedFile["result"]["ID"];
Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description, Token);
```
```sh title="CLI command example"
oint bitrix24 SendFile --url %url% --chat %chat% --fileid %fileid% --description %description% --token %token%
```
```json title="Result"
{
"result": {
"FILES": {
"upload3254": {
"id": 3254,
"chatId": 254,
"date": {},
"type": "file",
"name": "Imortant doc.docx",
"extension": "docx",
"size": 24071,
"image": false,
"status": "done",
"progress": 100,
"authorId": 1,
"authorName": "Anton Titovets",
"urlPreview": "",
"urlShow": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"urlDownload": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"viewerAttrs": {
"viewer": null,
"viewerType": "cloud-document",
"src": "/bitrix/services/main/ajax.php?action=disk.api.file.download&SITE_ID=s1&humanRE=1&fileId=3254&fileName=%D0%92%D0%B0%D0%B6%D0%BD%D1%8B%D0%B9%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.docx",
"viewerTypeClass": "BX.Messenger.Integration.Viewer.OnlyOfficeChatItem",
"viewerSeparateItem": true,
"viewerExtension": "im.integration.viewer",
"objectId": "3254",
"imChatId": 254,
"title": "Imortant doc.docx",
"actions": "[{\"type\":\"download\"},{\"type\":\"copyToMe\",\"text\":\"Save to Bitrix24 Drive\",\"action\":\"BXIM.disk.saveToDiskAction\",\"params\":{\"fileId\":\"3254\"},\"extension\":\"disk.viewer.actions\",\"buttonIconClass\":\"ui-btn-icon-cloud\"}]"
}
}
},
"DISK_ID": [
"3254"
],
"FILE_MODELS": {
"upload3254": {
"id": 3254,
"name": "Imortant doc.docx",
"createTime": {},
"updateTime": {},
"deleteTime": null,
"code": null,
"xmlId": null,
"storageId": 6,
"realObjectId": 3254,
"parentId": 3250,
"deletedType": 0,
"createdBy": "1",
"updatedBy": "1",
"deletedBy": "0",
"typeFile": 4,
"globalContentVersion": 2,
"fileId": 2330,
"size": 24071,
"etag": "1179305ea90d0b0fef106e1163deaeb8",
"links": {
"download": "/bitrix/services/main/ajax.php?action=disk.file.download&SITE_ID=s1&fileId=3254",
"showInGrid": "/bitrix/tools/disk/focus.php?objectId=3254&action=showObjectInGrid&ncc=1"
}
}
},
"MESSAGE_ID": 5346
},
"time": {
"start": 1720969175.0006,
"finish": 1720969175.09084,
"duration": 0.0902431011199951,
"processing": 0.0652461051940918,
"date_start": "2024-07-14T14:59:35+00:00",
"date_finish": "2024-07-14T14:59:35+00:00",
"operating_reset_at": 1720969775,
"operating": 0
}
}
```

146
docs/en/md/Bitrix24/Message-management/Send-message.md
View File

@ -1,73 +1,73 @@
---
sidebar_position: 1
---
# Send message
Send message to dialog
`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Text | --text | String | Message text |
| Attachments | --blocks | Array of Structure | Array of attachments |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.SendMessage(URL, UserID, Text,, Token);
```
```sh title="CLI command example"
oint bitrix24 SendMessage --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 5342,
"time": {
"start": 1720969163.89343,
"finish": 1720969163.95538,
"duration": 0.061945915222168,
"processing": 0.0366020202636719,
"date_start": "2024-07-14T14:59:23+00:00",
"date_finish": "2024-07-14T14:59:23+00:00",
"operating_reset_at": 1720969763,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Send message
Send message to dialog
`Function SendMessage(Val URL, Val ChatID, Val Text, Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| ChatID | --chat | String, Number | Chat ID (as chatXXX) or User ID (as XXX) |
| Text | --text | String | Message text |
| Attachments | --blocks | Array of Structure | Array of attachments |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12115)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "chat" + "450";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.SendMessage(URL, ChatID, Text, Attachments);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.SendMessage(URL, UserID, Text,, Token);
```
```sh title="CLI command example"
oint bitrix24 SendMessage --url %url% --chat %chat% --text %text% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 5342,
"time": {
"start": 1720969163.89343,
"finish": 1720969163.95538,
"duration": 0.061945915222168,
"processing": 0.0366020202636719,
"date_start": "2024-07-14T14:59:23+00:00",
"date_finish": "2024-07-14T14:59:23+00:00",
"operating_reset_at": 1720969763,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Message-management/Set-message-reaction.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 3
---
# Set message reaction
Set or remove reaction mark on the message
`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| MessageID | --message | String, Number | Message ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
MessageID = "8682";
Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
MessageID = "8684";
Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 SetMessageReaction --url %url% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969166.51361,
"finish": 1720969166.55322,
"duration": 0.0396139621734619,
"processing": 0.0151541233062744,
"date_start": "2024-07-14T14:59:26+00:00",
"date_finish": "2024-07-14T14:59:26+00:00",
"operating_reset_at": 1720969766,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Set message reaction
Set or remove reaction mark on the message
`Function SetMessageReaction(Val URL, Val MessageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| MessageID | --message | String, Number | Message ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12121)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
MessageID = "8682";
Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
MessageID = "8684";
Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID, Token);
```
```sh title="CLI command example"
oint bitrix24 SetMessageReaction --url %url% --message %message% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720969166.51361,
"finish": 1720969166.55322,
"duration": 0.0396139621734619,
"processing": 0.0151541233062744,
"date_start": "2024-07-14T14:59:26+00:00",
"date_finish": "2024-07-14T14:59:26+00:00",
"operating_reset_at": 1720969766,
"operating": 0
}
}
```

152
docs/en/md/Bitrix24/Notifications-managment/Create-personal-notification.md
View File

@ -1,76 +1,76 @@
---
sidebar_position: 1
---
# Create personal notification
Creates a personal notification to the user
`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --user | String, Number | User ID for sending the notification |
| Text | --text | String | Notification text |
| Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted |
| Attachments | --blocks | Array of Structure | Array of attachments |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129)
:::
<br/>
```bsl title="Code example"
UserID = 1;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text,,Attachments);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Tag = "New";
UserID = 10;
Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 7450,
"time": {
"start": 1722087269.44996,
"finish": 1722087269.50075,
"duration": 0.0507829189300537,
"processing": 0.0262038707733154,
"date_start": "2024-07-27T13:34:29+00:00",
"date_finish": "2024-07-27T13:34:29+00:00",
"operating_reset_at": 1722087869,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Create personal notification
Creates a personal notification to the user
`Function CreatePersonalNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --user | String, Number | User ID for sending the notification |
| Text | --text | String | Notification text |
| Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted |
| Attachments | --blocks | Array of Structure | Array of attachments |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12129)
:::
<br/>
```bsl title="Code example"
UserID = 1;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text,,Attachments);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Tag = "New";
UserID = 10;
Result = OPI_Bitrix24.CreatePersonalNotification(URL, UserID, Text, Tag,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 7450,
"time": {
"start": 1722087269.44996,
"finish": 1722087269.50075,
"duration": 0.0507829189300537,
"processing": 0.0262038707733154,
"date_start": "2024-07-27T13:34:29+00:00",
"date_finish": "2024-07-27T13:34:29+00:00",
"operating_reset_at": 1722087869,
"operating": 0
}
}
```

152
docs/en/md/Bitrix24/Notifications-managment/Create-system-notification.md
View File

@ -1,76 +1,76 @@
---
sidebar_position: 2
---
# Create system notification
Creates a system notification to the user
`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --user | String, Number | User ID for sending the notification |
| Text | --text | String | Notification text |
| Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted |
| Attachments | --blocks | Array of Structure | Array of attachments |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131)
:::
<br/>
```bsl title="Code example"
UserID = 1;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text,,Attachments);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Tag = "New";
UserID = 10;
Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 7454,
"time": {
"start": 1722087270.72466,
"finish": 1722087270.78145,
"duration": 0.0567879676818848,
"processing": 0.0293958187103272,
"date_start": "2024-07-27T13:34:30+00:00",
"date_finish": "2024-07-27T13:34:30+00:00",
"operating_reset_at": 1722087870,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Create system notification
Creates a system notification to the user
`Function CreateSystemNotification(Val URL, Val UserID, Val Text, Val Tag = "", Val Attachments = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| UserID | --user | String, Number | User ID for sending the notification |
| Text | --text | String | Notification text |
| Tag | --tag | String | Uniqueness Tag. If already exist, other notif. will be deleted |
| Attachments | --blocks | Array of Structure | Array of attachments |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12131)
:::
<br/>
```bsl title="Code example"
UserID = 1;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
Attachments = New Array;
Attachments.Add(OPI_Bitrix24.GetPictureBlock("Image1", Image));
Attachments.Add(OPI_Bitrix24.GetFileBlock("File1.docx", File));
Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text,,Attachments);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Tag = "New";
UserID = 10;
Result = OPI_Bitrix24.CreateSystemNotification(URL, UserID, Text, Tag,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```
```json title="Result"
{
"result": 7454,
"time": {
"start": 1722087270.72466,
"finish": 1722087270.78145,
"duration": 0.0567879676818848,
"processing": 0.0293958187103272,
"date_start": "2024-07-27T13:34:30+00:00",
"date_finish": "2024-07-27T13:34:30+00:00",
"operating_reset_at": 1722087870,
"operating": 0
}
}
```

128
docs/en/md/Bitrix24/Notifications-managment/Delete-notification.md
View File

@ -1,64 +1,64 @@
---
sidebar_position: 3
---
# Delete notification
Delete notification by ID
`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| NotificationID | --notif | String, Number | Notification ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
NotificationID = "8690";
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
NotificationID = "8692";
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722087271.36087,
"finish": 1722087271.39818,
"duration": 0.0373120307922363,
"processing": 0.0110759735107422,
"date_start": "2024-07-27T13:34:31+00:00",
"date_finish": "2024-07-27T13:34:31+00:00",
"operating_reset_at": 1722087871,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Delete notification
Delete notification by ID
`Function DeleteNotification(Val URL, Val NotificationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| NotificationID | --notif | String, Number | Notification ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=12133)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
NotificationID = "8690";
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
NotificationID = "8692";
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1722087271.36087,
"finish": 1722087271.39818,
"duration": 0.0373120307922363,
"processing": 0.0110759735107422,
"date_start": "2024-07-27T13:34:31+00:00",
"date_finish": "2024-07-27T13:34:31+00:00",
"operating_reset_at": 1722087871,
"operating": 0
}
}
```

166
docs/en/md/Bitrix24/Storages-managment/Create-storage-folder.md
View File

@ -1,83 +1,83 @@
---
sidebar_position: 6
---
# Create folder at the storage
Create new foldera at the storage
`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String | Storage ID |
| Name | --title | String | Folder name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php)
:::
<br/>
```bsl title="Code example"
StorageID = 3;
Name = "New catalog";
Filename2 = "New folder 2";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateStorageFolder --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 574,
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": 574,
"PARENT_ID": "3",
"DELETED_TYPE": 0,
"CREATE_TIME": "2024-06-22T09:07:36+00:00",
"UPDATE_TIME": "2024-06-22T09:07:36+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719047256.22025,
"finish": 1719047256.27758,
"duration": 0.057330846786499,
"processing": 0.0276291370391846,
"date_start": "2024-06-22T09:07:36+00:00",
"date_finish": "2024-06-22T09:07:36+00:00",
"operating_reset_at": 1719047856,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Create folder at the storage
Create new foldera at the storage
`Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String | Storage ID |
| Name | --title | String | Folder name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.addfolder](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_addfolder.php)
:::
<br/>
```bsl title="Code example"
StorageID = 3;
Name = "New catalog";
Filename2 = "New folder 2";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateStorageFolder --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": 574,
"NAME": "New catalog",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "folder",
"REAL_OBJECT_ID": 574,
"PARENT_ID": "3",
"DELETED_TYPE": 0,
"CREATE_TIME": "2024-06-22T09:07:36+00:00",
"UPDATE_TIME": "2024-06-22T09:07:36+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": null,
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/path/New catalog"
},
"time": {
"start": 1719047256.22025,
"finish": 1719047256.27758,
"duration": 0.057330846786499,
"processing": 0.0276291370391846,
"date_start": "2024-06-22T09:07:36+00:00",
"date_finish": "2024-06-22T09:07:36+00:00",
"operating_reset_at": 1719047856,
"operating": 0
}
}
```

130
docs/en/md/Bitrix24/Storages-managment/Get-app-sotrage.md
View File

@ -1,65 +1,65 @@
---
sidebar_position: 2
---
# Get storage for application data
Get information about storage with which the application can work to store its data
`Function GetAppSotrage(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php)
:::
<br/>
```bsl title="Code example"
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetAppSotrage(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetAppSotrage --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "18",
"NAME": "New storage name",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "restapp",
"ENTITY_ID": "2",
"ROOT_OBJECT_ID": "464"
},
"time": {
"start": 1721067694.96416,
"finish": 1721067694.99489,
"duration": 0.0307230949401856,
"processing": 0.00391507148742676,
"date_start": "2024-07-15T18:21:34+00:00",
"date_finish": "2024-07-15T18:21:34+00:00",
"operating_reset_at": 1721068294,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Get storage for application data
Get information about storage with which the application can work to store its data
`Function GetAppSotrage(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.getforapp](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getforapp.php)
:::
<br/>
```bsl title="Code example"
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetAppSotrage(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetAppSotrage --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "18",
"NAME": "New storage name",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "restapp",
"ENTITY_ID": "2",
"ROOT_OBJECT_ID": "464"
},
"time": {
"start": 1721067694.96416,
"finish": 1721067694.99489,
"duration": 0.0307230949401856,
"processing": 0.00391507148742676,
"date_start": "2024-07-15T18:21:34+00:00",
"date_finish": "2024-07-15T18:21:34+00:00",
"operating_reset_at": 1721068294,
"operating": 0
}
}
```

210
docs/en/md/Bitrix24/Storages-managment/Get-storage-objects.md
View File

@ -1,105 +1,105 @@
---
sidebar_position: 5
---
# Get a list of child storage objects
Get a list of files and folders, located at the root of the storage
`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
StorageID = 3;
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStorageObjects --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "568",
"NAME": "Picture2.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "558",
"SIZE": "2114023",
"CREATE_TIME": "2024-06-22T09:07:30+00:00",
"UPDATE_TIME": "2024-06-22T09:07:30+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg"
},
{
"ID": "570",
"NAME": "Picture1.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "560",
"SIZE": "805189",
"CREATE_TIME": "2024-06-22T09:07:32+00:00",
"UPDATE_TIME": "2024-06-22T09:07:32+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg"
}
],
"total": 2,
"time": {
"start": 1719047253.42516,
"finish": 1719047253.47205,
"duration": 0.0468947887420654,
"processing": 0.016359806060791,
"date_start": "2024-06-22T09:07:33+00:00",
"date_finish": "2024-06-22T09:07:33+00:00",
"operating_reset_at": 1719047853,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Get a list of child storage objects
Get a list of files and folders, located at the root of the storage
`Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.getchildren](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getchildren.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
StorageID = 3;
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStorageObjects --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "568",
"NAME": "Picture2.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "558",
"SIZE": "2114023",
"CREATE_TIME": "2024-06-22T09:07:30+00:00",
"UPDATE_TIME": "2024-06-22T09:07:30+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTY4Jl89NnBxNndlcmpudjQwY0tHNnZhdVN2VHZ2TTYwSmFFSXA%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UWTRKbDg5Tm5CeE5uZGxjbXB1ZGpRd1kwdEhOblpoZFZOMlZIWjJUVFl3U21GRlNYQT18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.qSfz7Ap6RM8nwlRRrw4lqlYcNQoHQJMcdzSbvlLHw60%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture2.jpg"
},
{
"ID": "570",
"NAME": "Picture1.jpg",
"CODE": null,
"STORAGE_ID": "3",
"TYPE": "file",
"PARENT_ID": "3",
"DELETED_TYPE": "0",
"GLOBAL_CONTENT_VERSION": "1",
"FILE_ID": "560",
"SIZE": "805189",
"CREATE_TIME": "2024-06-22T09:07:32+00:00",
"UPDATE_TIME": "2024-06-22T09:07:32+00:00",
"DELETE_TIME": null,
"CREATED_BY": "1",
"UPDATED_BY": "1",
"DELETED_BY": "0",
"DOWNLOAD_URL": "https://b24-ar17wx.bitrix24.by/rest/download.json?auth=efa17666006e9f06006b12e400000001000007b2f26f9898812ad669fd7da83d478d1a&token=disk%7CaWQ9NTcwJl89SmpkOWlyMGpwS1N1TEI1aWxIWWxtU0JtTllsT1BoNVI%3D%7CImRvd25sb2FkfGRpc2t8YVdROU5UY3dKbDg5U21wa09XbHlNR3B3UzFOMVRFSTFhV3hJV1d4dFUwSnRUbGxzVDFCb05WST18ZWZhMTc2NjYwMDZlOWYwNjAwNmIxMmU0MDAwMDAwMDEwMDAwMDdiMmYyNmY5ODk4ODEyYWQ2NjlmZDdkYTgzZDQ3OGQxYSI%3D.X8XQ3FtYG30XrOGGxoO1p%2FXistiComyxQei37Xh%2B%2FIM%3D",
"DETAIL_URL": "https://b24-ar17wx.bitrix24.by/docs/file/Picture1.jpg"
}
],
"total": 2,
"time": {
"start": 1719047253.42516,
"finish": 1719047253.47205,
"duration": 0.0468947887420654,
"processing": 0.016359806060791,
"date_start": "2024-06-22T09:07:33+00:00",
"date_finish": "2024-06-22T09:07:33+00:00",
"operating_reset_at": 1719047853,
"operating": 0
}
}
```

142
docs/en/md/Bitrix24/Storages-managment/Get-storage.md
View File

@ -1,71 +1,71 @@
---
sidebar_position: 3
---
# Get storage
Get information about storage
`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
StorageID = 3;
Result = OPI_Bitrix24.GetStorage(URL, StorageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStorage --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "3",
"NAME": "Main drive",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "common",
"ENTITY_ID": "shared_files_s1",
"ROOT_OBJECT_ID": "3"
},
"time": {
"start": 1719047247.65416,
"finish": 1719047247.68963,
"duration": 0.0354659557342529,
"processing": 0.00417995452880859,
"date_start": "2024-06-22T09:07:27+00:00",
"date_finish": "2024-06-22T09:07:27+00:00",
"operating_reset_at": 1719047847,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Get storage
Get information about storage
`Function GetStorage(Val URL, Val StorageID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.get](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
StorageID = 3;
Result = OPI_Bitrix24.GetStorage(URL, StorageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStorage --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "3",
"NAME": "Main drive",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "common",
"ENTITY_ID": "shared_files_s1",
"ROOT_OBJECT_ID": "3"
},
"time": {
"start": 1719047247.65416,
"finish": 1719047247.68963,
"duration": 0.0354659557342529,
"processing": 0.00417995452880859,
"date_start": "2024-06-22T09:07:27+00:00",
"date_finish": "2024-06-22T09:07:27+00:00",
"operating_reset_at": 1719047847,
"operating": 0
}
}
```

250
docs/en/md/Bitrix24/Storages-managment/Get-storages-list.md
View File

@ -1,125 +1,125 @@
---
sidebar_position: 1
---
# Get list of storages
Get list of available files storages
`Function GetStoragesList(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetStoragesList(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStoragesList(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStoragesList --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "3",
"NAME": "Main drive",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "common",
"ENTITY_ID": "shared_files_s1",
"ROOT_OBJECT_ID": "3"
},
{
"ID": "1",
"NAME": "Anton Titovets",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "1",
"ROOT_OBJECT_ID": "1"
},
{
"ID": "16",
"NAME": "iscript13@gmail.com",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "10",
"ROOT_OBJECT_ID": "270"
},
{
"ID": "4",
"NAME": "Payment Processing Customer Support",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "2",
"ROOT_OBJECT_ID": "4"
},
{
"ID": "10",
"NAME": "CoPilot",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "4",
"ROOT_OBJECT_ID": "52"
},
{
"ID": "12",
"NAME": "Support Bitrix24",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "6",
"ROOT_OBJECT_ID": "70"
},
{
"ID": "14",
"NAME": "Marta",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "8",
"ROOT_OBJECT_ID": "72"
}
],
"total": 7,
"time": {
"start": 1718783911.64028,
"finish": 1718783911.69026,
"duration": 0.0499801635742188,
"processing": 0.00660109519958496,
"date_start": "2024-06-19T07:58:31+00:00",
"date_finish": "2024-06-19T07:58:31+00:00",
"operating_reset_at": 1718784511,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Get list of storages
Get list of available files storages
`Function GetStoragesList(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.getlist](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetStoragesList(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStoragesList(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStoragesList --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "3",
"NAME": "Main drive",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "common",
"ENTITY_ID": "shared_files_s1",
"ROOT_OBJECT_ID": "3"
},
{
"ID": "1",
"NAME": "Anton Titovets",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "1",
"ROOT_OBJECT_ID": "1"
},
{
"ID": "16",
"NAME": "iscript13@gmail.com",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "10",
"ROOT_OBJECT_ID": "270"
},
{
"ID": "4",
"NAME": "Payment Processing Customer Support",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "2",
"ROOT_OBJECT_ID": "4"
},
{
"ID": "10",
"NAME": "CoPilot",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "4",
"ROOT_OBJECT_ID": "52"
},
{
"ID": "12",
"NAME": "Support Bitrix24",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "6",
"ROOT_OBJECT_ID": "70"
},
{
"ID": "14",
"NAME": "Marta",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "8",
"ROOT_OBJECT_ID": "72"
}
],
"total": 7,
"time": {
"start": 1718783911.64028,
"finish": 1718783911.69026,
"duration": 0.0499801635742188,
"processing": 0.00660109519958496,
"date_start": "2024-06-19T07:58:31+00:00",
"date_finish": "2024-06-19T07:58:31+00:00",
"operating_reset_at": 1718784511,
"operating": 0
}
}
```

138
docs/en/md/Bitrix24/Storages-managment/Rename-storage.md
View File

@ -1,69 +1,69 @@
---
sidebar_position: 4
---
# Rename storage
Change storage name (for app storage only, see. GetAppStorage)
`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Name | --title | String | New storage name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php)
:::
<br/>
```bsl title="Code example"
Name = "New storage name";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
StorageID = "18";
Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameStorage --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "18",
"NAME": "New storage name",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "restapp",
"ENTITY_ID": "2",
"ROOT_OBJECT_ID": "464"
},
"time": {
"start": 1719047246.29499,
"finish": 1719047246.35783,
"duration": 0.062842845916748,
"processing": 0.0317339897155762,
"date_start": "2024-06-22T09:07:26+00:00",
"date_finish": "2024-06-22T09:07:26+00:00",
"operating_reset_at": 1719047846,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Rename storage
Change storage name (for app storage only, see. GetAppStorage)
`Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Name | --title | String | New storage name |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [disk.storage.rename](https://dev.1c-bitrix.ru/rest_help/disk/storage/disk_storage_rename.php)
:::
<br/>
```bsl title="Code example"
Name = "New storage name";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
StorageID = "18";
Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameStorage --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"ID": "18",
"NAME": "New storage name",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "restapp",
"ENTITY_ID": "2",
"ROOT_OBJECT_ID": "464"
},
"time": {
"start": 1719047246.29499,
"finish": 1719047246.35783,
"duration": 0.062842845916748,
"processing": 0.0317339897155762,
"date_start": "2024-06-22T09:07:26+00:00",
"date_finish": "2024-06-22T09:07:26+00:00",
"operating_reset_at": 1719047846,
"operating": 0
}
}
```

136
docs/en/md/Bitrix24/Tasks-checklists-managment/Add-tasks-checklist-element.md
View File

@ -1,68 +1,68 @@
---
sidebar_position: 1
---
# Add tasks checklist element
Adds new element of tasks checklist
`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Text | --text | String | Text (title) of checklist element |
| Completed | --complete | Boolean | Mark as completed |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Text = "Checklist element";
Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text,, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTasksChecklistElement --url %url% --task %task% --text %text% --complete %complete% --token %token%
```
```json title="Result"
{
"result": 96,
"time": {
"start": 1720816505.3041,
"finish": 1720816505.37014,
"duration": 0.0660440921783447,
"processing": 0.0380921363830566,
"date_start": "2024-07-12T20:35:05+00:00",
"date_finish": "2024-07-12T20:35:05+00:00",
"operating_reset_at": 1720817105,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Add tasks checklist element
Adds new element of tasks checklist
`Function AddTasksChecklistElement(Val URL, Val TaskID, Val Text, Val Completed = False, Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Text | --text | String | Text (title) of checklist element |
| Completed | --complete | Boolean | Mark as completed |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Text = "Checklist element";
Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text, True);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.AddTasksChecklistElement(URL, TaskID, Text,, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTasksChecklistElement --url %url% --task %task% --text %text% --complete %complete% --token %token%
```
```json title="Result"
{
"result": 96,
"time": {
"start": 1720816505.3041,
"finish": 1720816505.37014,
"duration": 0.0660440921783447,
"processing": 0.0380921363830566,
"date_start": "2024-07-12T20:35:05+00:00",
"date_finish": "2024-07-12T20:35:05+00:00",
"operating_reset_at": 1720817105,
"operating": 0
}
}
```

136
docs/en/md/Bitrix24/Tasks-checklists-managment/Complete-tasks-checklist-element.md
View File

@ -1,68 +1,68 @@
---
sidebar_position: 6
---
# Complete tasks checklist element
Mark an element as completed
`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Element ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 CompleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816509.8981,
"finish": 1720816509.94922,
"duration": 0.0511200428009033,
"processing": 0.0246191024780273,
"date_start": "2024-07-12T20:35:09+00:00",
"date_finish": "2024-07-12T20:35:09+00:00",
"operating_reset_at": 1720817109,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Complete tasks checklist element
Mark an element as completed
`Function CompleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Element ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.complete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/complete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CompleteTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 CompleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816509.8981,
"finish": 1720816509.94922,
"duration": 0.0511200428009033,
"processing": 0.0246191024780273,
"date_start": "2024-07-12T20:35:09+00:00",
"date_finish": "2024-07-12T20:35:09+00:00",
"operating_reset_at": 1720817109,
"operating": 0
}
}
```

136
docs/en/md/Bitrix24/Tasks-checklists-managment/Delete-tasks-checklist-element.md
View File

@ -1,68 +1,68 @@
---
sidebar_position: 3
---
# Delete tasks checklist element
Deletes element from tasks checklist
`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | ID of deleted element |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816512.25818,
"finish": 1720816512.30984,
"duration": 0.0516610145568848,
"processing": 0.0264489650726318,
"date_start": "2024-07-12T20:35:12+00:00",
"date_finish": "2024-07-12T20:35:12+00:00",
"operating_reset_at": 1720817112,
"operating": 0
}
}
```
---
sidebar_position: 3
---
# Delete tasks checklist element
Deletes element from tasks checklist
`Function DeleteTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | ID of deleted element |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeleteTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816512.25818,
"finish": 1720816512.30984,
"duration": 0.0516610145568848,
"processing": 0.0264489650726318,
"date_start": "2024-07-12T20:35:12+00:00",
"date_finish": "2024-07-12T20:35:12+00:00",
"operating_reset_at": 1720817112,
"operating": 0
}
}
```

162
docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist-element.md
View File

@ -1,81 +1,81 @@
---
sidebar_position: 5
---
# Get tasks checklist element
Gets tasks checklist element by ID
`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Element ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": {
"ID": "96",
"TASK_ID": "632",
"PARENT_ID": "94",
"CREATED_BY": "1",
"TITLE": "New elements text",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
"time": {
"start": 1720816508.81324,
"finish": 1720816508.85536,
"duration": 0.0421209335327148,
"processing": 0.0174088478088379,
"date_start": "2024-07-12T20:35:08+00:00",
"date_finish": "2024-07-12T20:35:08+00:00",
"operating_reset_at": 1720817108,
"operating": 0
}
}
```
---
sidebar_position: 5
---
# Get tasks checklist element
Gets tasks checklist element by ID
`Function GetTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Element ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.get](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/get.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": {
"ID": "96",
"TASK_ID": "632",
"PARENT_ID": "94",
"CREATED_BY": "1",
"TITLE": "New elements text",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
"time": {
"start": 1720816508.81324,
"finish": 1720816508.85536,
"duration": 0.0421209335327148,
"processing": 0.0174088478088379,
"date_start": "2024-07-12T20:35:08+00:00",
"date_finish": "2024-07-12T20:35:08+00:00",
"operating_reset_at": 1720817108,
"operating": 0
}
}
```

186
docs/en/md/Bitrix24/Tasks-checklists-managment/Get-tasks-checklist.md
View File

@ -1,93 +1,93 @@
---
sidebar_position: 4
---
# Get tasks checklist
Gets the list of elements on the task checklist
`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTasksChecklist --url %url% --task %task% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "94",
"TASK_ID": "632",
"PARENT_ID": 0,
"CREATED_BY": "1",
"TITLE": "BX_CHECKLIST_1",
"SORT_INDEX": "0",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "96",
"TASK_ID": "632",
"PARENT_ID": "94",
"CREATED_BY": "1",
"TITLE": "New elements text",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
}
],
"time": {
"start": 1720816507.68937,
"finish": 1720816507.74166,
"duration": 0.0522880554199219,
"processing": 0.0231881141662598,
"date_start": "2024-07-12T20:35:07+00:00",
"date_finish": "2024-07-12T20:35:07+00:00",
"operating_reset_at": 1720817107,
"operating": 0
}
}
```
---
sidebar_position: 4
---
# Get tasks checklist
Gets the list of elements on the task checklist
`Function GetTasksChecklist(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.GetTasksChecklist(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTasksChecklist --url %url% --task %task% --token %token%
```
```json title="Result"
{
"result": [
{
"ID": "94",
"TASK_ID": "632",
"PARENT_ID": 0,
"CREATED_BY": "1",
"TITLE": "BX_CHECKLIST_1",
"SORT_INDEX": "0",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "96",
"TASK_ID": "632",
"PARENT_ID": "94",
"CREATED_BY": "1",
"TITLE": "New elements text",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
}
],
"time": {
"start": 1720816507.68937,
"finish": 1720816507.74166,
"duration": 0.0522880554199219,
"processing": 0.0231881141662598,
"date_start": "2024-07-12T20:35:07+00:00",
"date_finish": "2024-07-12T20:35:07+00:00",
"operating_reset_at": 1720817107,
"operating": 0
}
}
```

136
docs/en/md/Bitrix24/Tasks-checklists-managment/Renew-tasks-checklist-element.md
View File

@ -1,68 +1,68 @@
---
sidebar_position: 7
---
# Renew tasks checklist element
Unmark an element as completed
`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Element ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 RenewTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816511.09347,
"finish": 1720816511.14508,
"duration": 0.051609992980957,
"processing": 0.0250108242034912,
"date_start": "2024-07-12T20:35:11+00:00",
"date_finish": "2024-07-12T20:35:11+00:00",
"operating_reset_at": 1720817111,
"operating": 0
}
}
```
---
sidebar_position: 7
---
# Renew tasks checklist element
Unmark an element as completed
`Function RenewTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Element ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.renew](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/renew.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID);
TaskID = "1080";
ElementID = "400";
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RenewTasksChecklistElement(URL, TaskID, ElementID, Token);
```
```sh title="CLI command example"
oint bitrix24 RenewTasksChecklistElement --url %url% --task %task% --element %element% --token %token%
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816511.09347,
"finish": 1720816511.14508,
"duration": 0.051609992980957,
"processing": 0.0250108242034912,
"date_start": "2024-07-12T20:35:11+00:00",
"date_finish": "2024-07-12T20:35:11+00:00",
"operating_reset_at": 1720817111,
"operating": 0
}
}
```

140
docs/en/md/Bitrix24/Tasks-checklists-managment/Update-tasks-checklist-element.md
View File

@ -1,70 +1,70 @@
---
sidebar_position: 2
---
# Update tasks checklist element
Updates text of element of tasks checklist
`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Checklist element ID |
| Text | --text | String | Text (title) of checklist element |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Text = "New elements text";
Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
ElementID = "400";
Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateTasksChecklistElement --url %url% --task %task% --element %element% --text %text% --token %token%
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720816506.52861,
"finish": 1720816506.58416,
"duration": 0.0555450916290283,
"processing": 0.027979850769043,
"date_start": "2024-07-12T20:35:06+00:00",
"date_finish": "2024-07-12T20:35:06+00:00",
"operating_reset_at": 1720817106,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Update tasks checklist element
Updates text of element of tasks checklist
`Function UpdateTasksChecklistElement(Val URL, Val TaskID, Val ElementID, Val Text, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| ElementID | --element | Number, String | Checklist element ID |
| Text | --text | String | Text (title) of checklist element |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.checklistitem.update](https://dev.1c-bitrix.ru/rest_help/tasks/task/checklistitem/update.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
ElementID = "396";
Text = "New elements text";
Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
ElementID = "400";
Result = OPI_Bitrix24.UpdateTasksChecklistElement(URL, TaskID, ElementID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateTasksChecklistElement --url %url% --task %task% --element %element% --text %text% --token %token%
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720816506.52861,
"finish": 1720816506.58416,
"duration": 0.0555450916290283,
"processing": 0.027979850769043,
"date_start": "2024-07-12T20:35:06+00:00",
"date_finish": "2024-07-12T20:35:06+00:00",
"operating_reset_at": 1720817106,
"operating": 0
}
}
```

136
docs/en/md/Bitrix24/Tasks-managment/Attach-file-to-topic.md
View File

@ -1,68 +1,68 @@
---
sidebar_position: 6
---
# Attach file to the topic
Attaches a file to the selected task
`Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| FileID | --fileid | Number, String | File ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
FileID = "5006";
Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 AttachFileToTopic --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"attachmentId": 598
},
"time": {
"start": 1720017736.90778,
"finish": 1720017736.97555,
"duration": 0.0677700042724609,
"processing": 0.0367820262908936,
"date_start": "2024-07-03T14:42:16+00:00",
"date_finish": "2024-07-03T14:42:16+00:00",
"operating_reset_at": 1720018336,
"operating": 0
}
}
```
---
sidebar_position: 6
---
# Attach file to the topic
Attaches a file to the selected task
`Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| FileID | --fileid | Number, String | File ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.files.attach](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_files_attach.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
FileID = "5006";
Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 AttachFileToTopic --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"attachmentId": 598
},
"time": {
"start": 1720017736.90778,
"finish": 1720017736.97555,
"duration": 0.0677700042724609,
"processing": 0.0367820262908936,
"date_start": "2024-07-03T14:42:16+00:00",
"date_finish": "2024-07-03T14:42:16+00:00",
"operating_reset_at": 1720018336,
"operating": 0
}
}
```

256
docs/en/md/Bitrix24/Tasks-managment/Check-task-accesses.md
View File

@ -1,128 +1,128 @@
---
sidebar_position: 20
---
# Check task acesses for users
Checks the availability of the task for users
`Function CheckTaskAccesses(Val URL, Val TaskID, Val Users = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Users | --users | Array of String | User IDs for access checking |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php)
:::
<br/>
```bsl title="Code example"
ArrayOfUsers = New Array;
ArrayOfUsers.Add("1");
ArrayOfUsers.Add("10");
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers, Token);
```
```sh title="CLI command example"
oint bitrix24 CheckTaskAccesses --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"allowedActions": {
"1": {
"ACCEPT": false,
"DECLINE": false,
"COMPLETE": true,
"APPROVE": false,
"DISAPPROVE": false,
"START": true,
"PAUSE": false,
"DELEGATE": true,
"REMOVE": true,
"EDIT": true,
"DEFER": true,
"RENEW": false,
"CREATE": true,
"CHANGE_DEADLINE": true,
"CHECKLIST_ADD_ITEMS": true,
"ADD_FAVORITE": true,
"DELETE_FAVORITE": false,
"RATE": true,
"EDIT.ORIGINATOR": false,
"CHECKLIST.REORDER": true,
"ELAPSEDTIME.ADD": true,
"DAYPLAN.TIMER.TOGGLE": false,
"EDIT.PLAN": true,
"CHECKLIST.ADD": true,
"FAVORITE.ADD": true,
"FAVORITE.DELETE": false
},
"10": {
"ACCEPT": false,
"DECLINE": false,
"COMPLETE": true,
"APPROVE": false,
"DISAPPROVE": false,
"START": true,
"PAUSE": false,
"DELEGATE": true,
"REMOVE": false,
"EDIT": false,
"DEFER": true,
"RENEW": false,
"CREATE": true,
"CHANGE_DEADLINE": false,
"CHECKLIST_ADD_ITEMS": true,
"ADD_FAVORITE": true,
"DELETE_FAVORITE": false,
"RATE": false,
"EDIT.ORIGINATOR": false,
"CHECKLIST.REORDER": false,
"ELAPSEDTIME.ADD": true,
"DAYPLAN.TIMER.TOGGLE": false,
"EDIT.PLAN": false,
"CHECKLIST.ADD": true,
"FAVORITE.ADD": true,
"FAVORITE.DELETE": false
}
}
},
"time": {
"start": 1720017732.79312,
"finish": 1720017732.85673,
"duration": 0.0636129379272461,
"processing": 0.0308799743652344,
"date_start": "2024-07-03T14:42:12+00:00",
"date_finish": "2024-07-03T14:42:12+00:00",
"operating_reset_at": 1720018332,
"operating": 0
}
}
```
---
sidebar_position: 20
---
# Check task acesses for users
Checks the availability of the task for users
`Function CheckTaskAccesses(Val URL, Val TaskID, Val Users = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Users | --users | Array of String | User IDs for access checking |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.getaccess](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/tasks_task_getaccess.php)
:::
<br/>
```bsl title="Code example"
ArrayOfUsers = New Array;
ArrayOfUsers.Add("1");
ArrayOfUsers.Add("10");
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.CheckTaskAccesses(URL, TaskID, ArrayOfUsers, Token);
```
```sh title="CLI command example"
oint bitrix24 CheckTaskAccesses --url "b24-ar17wx.bitrix24.by" --task "502" --users %users% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"allowedActions": {
"1": {
"ACCEPT": false,
"DECLINE": false,
"COMPLETE": true,
"APPROVE": false,
"DISAPPROVE": false,
"START": true,
"PAUSE": false,
"DELEGATE": true,
"REMOVE": true,
"EDIT": true,
"DEFER": true,
"RENEW": false,
"CREATE": true,
"CHANGE_DEADLINE": true,
"CHECKLIST_ADD_ITEMS": true,
"ADD_FAVORITE": true,
"DELETE_FAVORITE": false,
"RATE": true,
"EDIT.ORIGINATOR": false,
"CHECKLIST.REORDER": true,
"ELAPSEDTIME.ADD": true,
"DAYPLAN.TIMER.TOGGLE": false,
"EDIT.PLAN": true,
"CHECKLIST.ADD": true,
"FAVORITE.ADD": true,
"FAVORITE.DELETE": false
},
"10": {
"ACCEPT": false,
"DECLINE": false,
"COMPLETE": true,
"APPROVE": false,
"DISAPPROVE": false,
"START": true,
"PAUSE": false,
"DELEGATE": true,
"REMOVE": false,
"EDIT": false,
"DEFER": true,
"RENEW": false,
"CREATE": true,
"CHANGE_DEADLINE": false,
"CHECKLIST_ADD_ITEMS": true,
"ADD_FAVORITE": true,
"DELETE_FAVORITE": false,
"RATE": false,
"EDIT.ORIGINATOR": false,
"CHECKLIST.REORDER": false,
"ELAPSEDTIME.ADD": true,
"DAYPLAN.TIMER.TOGGLE": false,
"EDIT.PLAN": false,
"CHECKLIST.ADD": true,
"FAVORITE.ADD": true,
"FAVORITE.DELETE": false
}
}
},
"time": {
"start": 1720017732.79312,
"finish": 1720017732.85673,
"duration": 0.0636129379272461,
"processing": 0.0308799743652344,
"date_start": "2024-07-03T14:42:12+00:00",
"date_finish": "2024-07-03T14:42:12+00:00",
"operating_reset_at": 1720018332,
"operating": 0
}
}
```

144
docs/en/md/Bitrix24/Tasks-managment/Create-tasks-dependencies.md
View File

@ -1,72 +1,72 @@
---
sidebar_position: 23
---
# Create tasks dependencies
Creates the dependency of one task to another
`Function CreateTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FromID | --taskfrom | String, Number | From task ID |
| DestinationID | --taskto | String, Number | To task ID |
| LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php)
:::
<br/>
```bsl title="Code example"
FromID = "1078";
DestinationID = "1080";
LinkType = 0;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType);
FromID = "1080";
DestinationID = "1078";
LinkType = 2;
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateTasksDependencies --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [],
"time": {
"start": 1720186655.56394,
"finish": 1720186656.29235,
"duration": 0.728404998779297,
"processing": 0.692660093307495,
"date_start": "2024-07-05T13:37:35+00:00",
"date_finish": "2024-07-05T13:37:36+00:00",
"operating_reset_at": 1720187255,
"operating": 0.692637920379639
}
}
```
---
sidebar_position: 23
---
# Create tasks dependencies
Creates the dependency of one task to another
`Function CreateTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FromID | --taskfrom | String, Number | From task ID |
| DestinationID | --taskto | String, Number | To task ID |
| LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.dependence.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_add.php)
:::
<br/>
```bsl title="Code example"
FromID = "1078";
DestinationID = "1080";
LinkType = 0;
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType);
FromID = "1080";
DestinationID = "1078";
LinkType = 2;
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateTasksDependencies(URL, FromID, DestinationID, LinkType, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateTasksDependencies --url "b24-ar17wx.bitrix24.by" --taskfrom "502" --taskto "500" --linktype %linktype% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [],
"time": {
"start": 1720186655.56394,
"finish": 1720186656.29235,
"duration": 0.728404998779297,
"processing": 0.692660093307495,
"date_start": "2024-07-05T13:37:35+00:00",
"date_finish": "2024-07-05T13:37:36+00:00",
"operating_reset_at": 1720187255,
"operating": 0.692637920379639
}
}
```

108
docs/en/md/Bitrix24/Tasks-managment/Delete-tasks-dependencies.md
View File

@ -1,54 +1,54 @@
---
sidebar_position: 24
---
# Delete tasks dependencies
Removes the dependency of one task to another
`Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FromID | --taskfrom | String, Number | From task ID |
| DestinationID | --taskto | String, Number | To task ID |
| LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php)
:::
<br/>
```sh title="CLI command example"
oint bitrix24 DeleteTasksDependencies --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token%
```
```json title="Result"
{
"result": [],
"time": {
"start": 1720816479.3837,
"finish": 1720816479.41872,
"duration": 0.0350160598754883,
"processing": 0.00787091255187988,
"date_start": "2024-07-12T20:34:39+00:00",
"date_finish": "2024-07-12T20:34:39+00:00",
"operating_reset_at": 1720817079,
"operating": 0
}
}
```
---
sidebar_position: 24
---
# Delete tasks dependencies
Removes the dependency of one task to another
`Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FromID | --taskfrom | String, Number | From task ID |
| DestinationID | --taskto | String, Number | To task ID |
| LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.dependence.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/dependence/task_dependence_delete.php)
:::
<br/>
```sh title="CLI command example"
oint bitrix24 DeleteTasksDependencies --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token%
```
```json title="Result"
{
"result": [],
"time": {
"start": 1720816479.3837,
"finish": 1720816479.41872,
"duration": 0.0350160598754883,
"processing": 0.00787091255187988,
"date_start": "2024-07-12T20:34:39+00:00",
"date_finish": "2024-07-12T20:34:39+00:00",
"operating_reset_at": 1720817079,
"operating": 0
}
}
```

122
docs/en/md/Bitrix24/Tasks-managment/Get-daily-plan.md
View File

@ -1,61 +1,61 @@
---
sidebar_position: 25
---
# Get users daily tasks plan
Gets the task plan for the current users day
`Function GetDailyPlan(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetDailyPlan(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetDailyPlan(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDailyPlan --url %url% --token %token%
```
```json title="Result"
{
"result": [],
"time": {
"start": 1720816513.42336,
"finish": 1720816513.45192,
"duration": 0.0285580158233643,
"processing": 0.000265121459960938,
"date_start": "2024-07-12T20:35:13+00:00",
"date_finish": "2024-07-12T20:35:13+00:00",
"operating_reset_at": 1720817113,
"operating": 0
}
}
```
---
sidebar_position: 25
---
# Get users daily tasks plan
Gets the task plan for the current users day
`Function GetDailyPlan(Val URL, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.planner.getlist](https://dev.1c-bitrix.ru/rest_help/tasks/task/planner/getlist.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
Result = OPI_Bitrix24.GetDailyPlan(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetDailyPlan(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetDailyPlan --url %url% --token %token%
```
```json title="Result"
{
"result": [],
"time": {
"start": 1720816513.42336,
"finish": 1720816513.45192,
"duration": 0.0285580158233643,
"processing": 0.000265121459960938,
"date_start": "2024-07-12T20:35:13+00:00",
"date_finish": "2024-07-12T20:35:13+00:00",
"operating_reset_at": 1720817113,
"operating": 0
}
}
```

388
docs/en/md/Bitrix24/Tasks-managment/Mute-task.md
View File

@ -1,194 +1,194 @@
---
sidebar_position: 21
---
# Mute task
Mute task by ID
`Function MuteTask(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.MuteTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.MuteTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 MuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "290",
"parentId": null,
"title": "Another task title",
"description": "Another task description",
"mark": null,
"priority": "1",
"multitask": "N",
"notViewed": "N",
"replicate": "N",
"stageId": "0",
"createdBy": "1",
"createdDate": "2024-07-03T14:41:38+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-07-03T14:41:45+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-07-03T14:41:38+00:00",
"dateStart": null,
"deadline": "2024-07-04T14:41:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}",
"xmlId": null,
"commentsCount": null,
"serviceCommentsCount": null,
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": null,
"forumId": null,
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "2",
"viewedDate": null,
"sorting": null,
"durationFact": null,
"isMuted": "Y",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-07-03T14:41:45+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [],
"accomplices": [],
"checklist": [],
"group": [],
"creator": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"responsible": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"accomplicesData": [],
"auditorsData": [],
"newCommentsCount": 0,
"action": {
"accept": false,
"decline": false,
"complete": true,
"approve": false,
"disapprove": false,
"start": true,
"pause": false,
"delegate": true,
"remove": true,
"edit": true,
"defer": true,
"renew": false,
"create": true,
"changeDeadline": true,
"checklistAddItems": true,
"addFavorite": true,
"deleteFavorite": false,
"rate": true,
"edit.originator": false,
"checklist.reorder": true,
"elapsedtime.add": true,
"dayplan.timer.toggle": false,
"edit.plan": true,
"checklist.add": true,
"favorite.add": true,
"favorite.delete": false
},
"checkListTree": {
"nodeId": 0,
"fields": {
"id": null,
"copiedId": null,
"entityId": null,
"userId": 1,
"createdBy": null,
"parentId": null,
"title": "",
"sortIndex": null,
"displaySortIndex": "",
"isComplete": false,
"isImportant": false,
"completedCount": 0,
"members": [],
"attachments": []
},
"action": [],
"descendants": []
},
"checkListCanAdd": true
}
},
"time": {
"start": 1720017708.44201,
"finish": 1720017708.51044,
"duration": 0.0684309005737305,
"processing": 0.0346000194549561,
"date_start": "2024-07-03T14:41:48+00:00",
"date_finish": "2024-07-03T14:41:48+00:00",
"operating_reset_at": 1720018308,
"operating": 0
}
}
```
---
sidebar_position: 21
---
# Mute task
Mute task by ID
`Function MuteTask(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.mute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.MuteTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.MuteTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 MuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "290",
"parentId": null,
"title": "Another task title",
"description": "Another task description",
"mark": null,
"priority": "1",
"multitask": "N",
"notViewed": "N",
"replicate": "N",
"stageId": "0",
"createdBy": "1",
"createdDate": "2024-07-03T14:41:38+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-07-03T14:41:45+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-07-03T14:41:38+00:00",
"dateStart": null,
"deadline": "2024-07-04T14:41:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}",
"xmlId": null,
"commentsCount": null,
"serviceCommentsCount": null,
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": null,
"forumId": null,
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "2",
"viewedDate": null,
"sorting": null,
"durationFact": null,
"isMuted": "Y",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-07-03T14:41:45+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [],
"accomplices": [],
"checklist": [],
"group": [],
"creator": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"responsible": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"accomplicesData": [],
"auditorsData": [],
"newCommentsCount": 0,
"action": {
"accept": false,
"decline": false,
"complete": true,
"approve": false,
"disapprove": false,
"start": true,
"pause": false,
"delegate": true,
"remove": true,
"edit": true,
"defer": true,
"renew": false,
"create": true,
"changeDeadline": true,
"checklistAddItems": true,
"addFavorite": true,
"deleteFavorite": false,
"rate": true,
"edit.originator": false,
"checklist.reorder": true,
"elapsedtime.add": true,
"dayplan.timer.toggle": false,
"edit.plan": true,
"checklist.add": true,
"favorite.add": true,
"favorite.delete": false
},
"checkListTree": {
"nodeId": 0,
"fields": {
"id": null,
"copiedId": null,
"entityId": null,
"userId": 1,
"createdBy": null,
"parentId": null,
"title": "",
"sortIndex": null,
"displaySortIndex": "",
"isComplete": false,
"isImportant": false,
"completedCount": 0,
"members": [],
"attachments": []
},
"action": [],
"descendants": []
},
"checkListCanAdd": true
}
},
"time": {
"start": 1720017708.44201,
"finish": 1720017708.51044,
"duration": 0.0684309005737305,
"processing": 0.0346000194549561,
"date_start": "2024-07-03T14:41:48+00:00",
"date_finish": "2024-07-03T14:41:48+00:00",
"operating_reset_at": 1720018308,
"operating": 0
}
}
```

388
docs/en/md/Bitrix24/Tasks-managment/Unmute-task.md
View File

@ -1,194 +1,194 @@
---
sidebar_position: 22
---
# Unmute task
Unmute task by ID
`Function UnmuteTask(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.UnmuteTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.UnmuteTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 UnmuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "290",
"parentId": null,
"title": "Another task title",
"description": "Another task description",
"mark": null,
"priority": "1",
"multitask": "N",
"notViewed": "N",
"replicate": "N",
"stageId": "0",
"createdBy": "1",
"createdDate": "2024-07-03T14:41:38+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-07-03T14:41:45+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-07-03T14:41:38+00:00",
"dateStart": null,
"deadline": "2024-07-04T14:41:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}",
"xmlId": null,
"commentsCount": null,
"serviceCommentsCount": null,
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": null,
"forumId": null,
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "2",
"viewedDate": null,
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-07-03T14:41:45+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [],
"accomplices": [],
"checklist": [],
"group": [],
"creator": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"responsible": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"accomplicesData": [],
"auditorsData": [],
"newCommentsCount": 0,
"action": {
"accept": false,
"decline": false,
"complete": true,
"approve": false,
"disapprove": false,
"start": true,
"pause": false,
"delegate": true,
"remove": true,
"edit": true,
"defer": true,
"renew": false,
"create": true,
"changeDeadline": true,
"checklistAddItems": true,
"addFavorite": true,
"deleteFavorite": false,
"rate": true,
"edit.originator": false,
"checklist.reorder": true,
"elapsedtime.add": true,
"dayplan.timer.toggle": false,
"edit.plan": true,
"checklist.add": true,
"favorite.add": true,
"favorite.delete": false
},
"checkListTree": {
"nodeId": 0,
"fields": {
"id": null,
"copiedId": null,
"entityId": null,
"userId": 1,
"createdBy": null,
"parentId": null,
"title": "",
"sortIndex": null,
"displaySortIndex": "",
"isComplete": false,
"isImportant": false,
"completedCount": 0,
"members": [],
"attachments": []
},
"action": [],
"descendants": []
},
"checkListCanAdd": true
}
},
"time": {
"start": 1720017709.85465,
"finish": 1720017709.91481,
"duration": 0.0601639747619629,
"processing": 0.0304751396179199,
"date_start": "2024-07-03T14:41:49+00:00",
"date_finish": "2024-07-03T14:41:49+00:00",
"operating_reset_at": 1720018309,
"operating": 0
}
}
```
---
sidebar_position: 22
---
# Unmute task
Unmute task by ID
`Function UnmuteTask(Val URL, Val TaskID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [tasks.task.unmute](https://dev.1c-bitrix.ru/rest_help/tasks/task/tasks/mute_unmute.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1078";
Result = OPI_Bitrix24.UnmuteTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
TaskID = "1080";
Result = OPI_Bitrix24.UnmuteTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 UnmuteTask --url "b24-ar17wx.bitrix24.by" --task "502" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "290",
"parentId": null,
"title": "Another task title",
"description": "Another task description",
"mark": null,
"priority": "1",
"multitask": "N",
"notViewed": "N",
"replicate": "N",
"stageId": "0",
"createdBy": "1",
"createdDate": "2024-07-03T14:41:38+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-07-03T14:41:45+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-07-03T14:41:38+00:00",
"dateStart": null,
"deadline": "2024-07-04T14:41:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{dca98bf4-187c-4489-ad23-8735dd49e2fc}",
"xmlId": null,
"commentsCount": null,
"serviceCommentsCount": null,
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": null,
"forumId": null,
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "2",
"viewedDate": null,
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-07-03T14:41:45+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [],
"accomplices": [],
"checklist": [],
"group": [],
"creator": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"responsible": {
"id": "1",
"name": "Anton Titovets",
"link": "/company/personal/user/1/",
"icon": "https://b24-ar17wx.bitrix24.by/b28528874/resize_cache/30/c0120a8d7c10d63c83e32398d1ec4d9e/main/d7e/d7e99cf556e4ab676463dae2c00ddfbb/a7e0af6899300e3c684caeca5c334d81.jpg",
"workPosition": null
},
"accomplicesData": [],
"auditorsData": [],
"newCommentsCount": 0,
"action": {
"accept": false,
"decline": false,
"complete": true,
"approve": false,
"disapprove": false,
"start": true,
"pause": false,
"delegate": true,
"remove": true,
"edit": true,
"defer": true,
"renew": false,
"create": true,
"changeDeadline": true,
"checklistAddItems": true,
"addFavorite": true,
"deleteFavorite": false,
"rate": true,
"edit.originator": false,
"checklist.reorder": true,
"elapsedtime.add": true,
"dayplan.timer.toggle": false,
"edit.plan": true,
"checklist.add": true,
"favorite.add": true,
"favorite.delete": false
},
"checkListTree": {
"nodeId": 0,
"fields": {
"id": null,
"copiedId": null,
"entityId": null,
"userId": 1,
"createdBy": null,
"parentId": null,
"title": "",
"sortIndex": null,
"displaySortIndex": "",
"isComplete": false,
"isImportant": false,
"completedCount": 0,
"members": [],
"attachments": []
},
"action": [],
"descendants": []
},
"checkListCanAdd": true
}
},
"time": {
"start": 1720017709.85465,
"finish": 1720017709.91481,
"duration": 0.0601639747619629,
"processing": 0.0304751396179199,
"date_start": "2024-07-03T14:41:49+00:00",
"date_finish": "2024-07-03T14:41:49+00:00",
"operating_reset_at": 1720018309,
"operating": 0
}
}
```

160
docs/en/md/Bitrix24/Timekeeping/Add-task-time-accounting.md
View File

@ -1,80 +1,80 @@
---
sidebar_position: 1
---
# Add task time accounting
Adds information about the user's time spent to the task
`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | String, Number | ID of task for time accounting |
| Time | --amount | String, Number | Time spent in seconds |
| UserID | --user | String, Number | ID of user for time accounting |
| Text | --text | String | Comment text |
| SetupDate | --date | String | Date the record was set |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1088";
Time = 3600;
Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Text = "Time spent on work";
UserID = 10;
Time = 7200;
SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1);
Result = OPI_Bitrix24.AddTaskTimeAccounting(URL
, TaskID
, Time
, UserID
, Text
, SetupDate
, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTaskTimeAccounting --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token%
```
```json title="Result"
{
"result": 42,
"time": {
"start": 1720816582.16849,
"finish": 1720816582.22964,
"duration": 0.0611569881439209,
"processing": 0.0315871238708496,
"date_start": "2024-07-12T20:36:22+00:00",
"date_finish": "2024-07-12T20:36:22+00:00",
"operating_reset_at": 1720817182,
"operating": 0
}
}
```
---
sidebar_position: 1
---
# Add task time accounting
Adds information about the user's time spent to the task
`Function AddTaskTimeAccounting(Val URL, Val TaskID, Val Time, Val UserID = "", Val Text = "", Val SetupDate = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | String, Number | ID of task for time accounting |
| Time | --amount | String, Number | Time spent in seconds |
| UserID | --user | String, Number | ID of user for time accounting |
| Text | --text | String | Comment text |
| SetupDate | --date | String | Date the record was set |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.elapseditem.add](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/add.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1088";
Time = 3600;
Result = OPI_Bitrix24.AddTaskTimeAccounting(URL, TaskID, Time);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
Text = "Time spent on work";
UserID = 10;
Time = 7200;
SetupDate = AddMonth(OPI_Tools.GetCurrentDate(), -1);
Result = OPI_Bitrix24.AddTaskTimeAccounting(URL
, TaskID
, Time
, UserID
, Text
, SetupDate
, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTaskTimeAccounting --url %url% --task %task% --amount %amount% --user %user% --text %text% --date %date% --token %token%
```
```json title="Result"
{
"result": 42,
"time": {
"start": 1720816582.16849,
"finish": 1720816582.22964,
"duration": 0.0611569881439209,
"processing": 0.0315871238708496,
"date_start": "2024-07-12T20:36:22+00:00",
"date_finish": "2024-07-12T20:36:22+00:00",
"operating_reset_at": 1720817182,
"operating": 0
}
}
```

132
docs/en/md/Bitrix24/Timekeeping/Delete-task-time-accounting.md
View File

@ -1,66 +1,66 @@
---
sidebar_position: 2
---
# Delete task time accounting
Deletes record of time accounting
`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | String, Number | ID of task for time accounting |
| RecordID | --record | String, Number | Time record ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1088";
RecordID = "306";
Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
RecordID = "308";
Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTaskTimeAccounting --url %url% --task %task% --record %record% --token %token%
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720816586.91135,
"finish": 1720816586.96255,
"duration": 0.0512039661407471,
"processing": 0.0238111019134522,
"date_start": "2024-07-12T20:36:26+00:00",
"date_finish": "2024-07-12T20:36:26+00:00",
"operating_reset_at": 1720817186,
"operating": 0
}
}
```
---
sidebar_position: 2
---
# Delete task time accounting
Deletes record of time accounting
`Function DeleteTaskTimeAccounting(Val URL, Val TaskID, Val RecordID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | String, Number | ID of task for time accounting |
| RecordID | --record | String, Number | Time record ID |
| Token | --token | String | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [task.elapseditem.delete](https://dev.1c-bitrix.ru/rest_help/tasks/task/elapseditem/delete.php)
:::
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
TaskID = "1088";
RecordID = "306";
Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID);
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
RecordID = "308";
Result = OPI_Bitrix24.DeleteTaskTimeAccounting(URL, TaskID, RecordID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTaskTimeAccounting --url %url% --task %task% --record %record% --token %token%
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720816586.91135,
"finish": 1720816586.96255,
"duration": 0.0512039661407471,
"processing": 0.0238111019134522,
"date_start": "2024-07-12T20:36:26+00:00",
"date_finish": "2024-07-12T20:36:26+00:00",
"operating_reset_at": 1720817186,
"operating": 0
}
}
```

Some files were not shown because too many files have changed in this diff Show More