1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-11-24 08:52:18 +02:00

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

This commit is contained in:
Vitaly the Alpaca 2024-06-20 07:39:55 +00:00 committed by Vitaly the Alpaca (bot)
parent 1f3f77eeb1
commit 6e2ddbd195
151 changed files with 18143 additions and 18 deletions

View File

@ -0,0 +1,60 @@
---
sidebar_position: 7
---
# Add new recipients to a post
Adds new groups or users to the recipients
*Function AddPostRecipients(Val URL, Val PostID, Val Visibility, 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 |
| Visibility | --vision | String | Array or a single post target: UA all, SG<X> work group, U<X> user, DR<X> depart., G<X> group |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
Visibility = "UA";
PostID = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility, Token);
```
```sh title="CLI command example"
oint bitrix24 AddPostRecipients --url "b24-ar17wx.bitrix24.by" --postid "124" --vision %vision% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718473318.17435,
"finish": 1718473318.21352,
"duration": 0.0391781330108643,
"processing": 0.00464105606079102,
"date_start": "2024-06-15T17:41:58+00:00",
"date_finish": "2024-06-15T17:41:58+00:00",
"operating_reset_at": 1718473918,
"operating": 0
}
}
```

View File

@ -0,0 +1,61 @@
---
sidebar_position: 6
---
# Create comment
Adds a comment to the post
*Function CrateComment(Val URL, Val PostID, Val Text, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Post ID |
| Text | --text | String | Comment text |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
Text = "Comment for post";
PostID = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.CrateComment(URL, PostID, Text);
Text = "Another comment";
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CrateComment(URL, PostID, Text, Token);
```
```sh title="CLI command example"
oint bitrix24 CrateComment --url "b24-ar17wx.bitrix24.by" --postid "124" --text %text% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 24,
"time": {
"start": 1718473316.57246,
"finish": 1718473316.67595,
"duration": 0.103492975234985,
"processing": 0.0729200839996338,
"date_start": "2024-06-15T17:41:56+00:00",
"date_finish": "2024-06-15T17:41:56+00:00",
"operating_reset_at": 1718473916,
"operating": 0
}
}
```

View File

@ -0,0 +1,71 @@
---
sidebar_position: 1
---
# Create post
Create a new post at news feed
*Function CreatePost(Val URL, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Important = False, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Text | --text | String | Text of post |
| Visibility | --vision | String | Array or a single post target: UA all, SG<X> work group, U<X> user, DR<X> depart., G<X> group |
| Files | --files | String | Data inложенandй, где toлюч > name file, value > path to file andдand дinоandчные Data |
| Title | --title | String | Post title |
| Important | --important | Boolean | Mark post as important |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
Text = "Text of post";
Title = "Post title";
Image1 = "https://openintegrations.dev/test_data/picture.jpg";
Image2 = "https://openintegrations.dev/test_data/picture2.jpg";
Files = New Map;
Files.Insert("1.png", Image1);
Files.Insert("2.png", Image2);
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.CreatePost(URL, Text,, Files, Title, True);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreatePost(URL, Text,, Files, Title,, Token);
```
```sh title="CLI command example"
oint bitrix24 CreatePost --url "b24-ar17wx.bitrix24.by" --text %text% --vision %vision% --files %files% --title %title% --important %important% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 18,
"time": {
"start": 1718130364.82176,
"finish": 1718130365.61903,
"duration": 0.797268867492676,
"processing": 0.63801383972168,
"date_start": "2024-06-11T18:26:04+00:00",
"date_finish": "2024-06-11T18:26:05+00:00",
"operating_reset_at": 1718130964,
"operating": 0.637988090515137
}
}
```

View File

@ -0,0 +1,59 @@
---
sidebar_position: 3
---
# Delete post
Remove post from a news feed
*Function DeletePost(Val URL, Val PostID, 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 | Id of post to remove |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
PostID = "122";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.DeletePost(URL, PostID);
PostID = "124";
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeletePost(URL, PostID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeletePost --url "b24-ar17wx.bitrix24.by" --postid "124" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718130367.40777,
"finish": 1718130367.7596,
"duration": 0.35182785987854,
"processing": 0.310530185699463,
"date_start": "2024-06-11T18:26:07+00:00",
"date_finish": "2024-06-11T18:26:07+00:00",
"operating_reset_at": 1718130967,
"operating": 0.310499906539917
}
}
```

View File

@ -0,0 +1,60 @@
---
sidebar_position: 4
---
# Get list of important post viewers
Return list of important post viewers ids
*Function GetImportantPostViewers(Val URL, Val PostID, 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 | Id of important post |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
PostID = "122";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetImportantPostViewers --url "b24-ar17wx.bitrix24.by" --postid "122" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
"1"
],
"time": {
"start": 1718304109.47482,
"finish": 1718304109.50417,
"duration": 0.0293447971343994,
"processing": 0.000212907791137695,
"date_start": "2024-06-13T18:41:49+00:00",
"date_finish": "2024-06-13T18:41:49+00:00",
"operating_reset_at": 1718304709,
"operating": 0
}
}
```

View File

@ -0,0 +1,414 @@
---
sidebar_position: 5
---
# Get posts
Gen post or array of post with ID or rights selection
*Function GetPosts(Val URL, Val PostID = "", Val Filter = "UA", Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Id of important post |
| Filter | --sel | String | Post selection by rights: UA all, SGn work group, Un user, DRn depart, Gn group |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
PostID = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetPosts(URL, PostID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetPosts(URL, PostID,, Token);
```
```sh title="CLI command example"
oint bitrix24 GetPosts --url "b24-ar17wx.bitrix24.by" --postid "124" --sel %sel% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "40",
"BLOG_ID": "1",
"PUBLISH_STATUS": "P",
"TITLE": "Post title",
"AUTHOR_ID": "1",
"ENABLE_COMMENTS": "Y",
"NUM_COMMENTS": "0",
"CODE": null,
"MICRO": "N",
"DETAIL_TEXT": "Text of post",
"DATE_PUBLISH": "2024-06-13T18:41:47+00:00",
"CATEGORY_ID": null,
"HAS_SOCNET_ALL": "N",
"HAS_TAGS": "N",
"HAS_IMAGES": "N",
"HAS_PROPS": "Y",
"HAS_COMMENT_IMAGES": null,
"UF_BLOG_POST_DOC": {
"ID": "1",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_BLOG_POST_DOC",
"USER_TYPE_ID": "file",
"XML_ID": "UF_BLOG_POST_DOC",
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": {
"SIZE": 20,
"LIST_WIDTH": 0,
"LIST_HEIGHT": 0,
"MAX_SHOW_SIZE": 0,
"MAX_ALLOWED_SIZE": 0,
"EXTENSIONS": [],
"TARGET_BLANK": "Y"
},
"EDIT_FORM_LABEL": null,
"LIST_COLUMN_LABEL": null,
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "file",
"CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType",
"EDIT_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\FileType",
"renderEdit"
],
"VIEW_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\FileType",
"renderView"
],
"USE_FIELD_COMPONENT": true,
"DESCRIPTION": "File",
"BASE_TYPE": "file"
},
"VALUE": false,
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"UF_BLOG_POST_URL_PRV": {
"ID": "5",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_BLOG_POST_URL_PRV",
"USER_TYPE_ID": "url_preview",
"XML_ID": "UF_BLOG_POST_URL_PRV",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": [],
"EDIT_FORM_LABEL": null,
"LIST_COLUMN_LABEL": null,
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "url_preview",
"CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType",
"DESCRIPTION": "Содержandмое withwithылtoand",
"BASE_TYPE": "int"
},
"VALUE": null,
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"UF_GRATITUDE": {
"ID": "9",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_GRATITUDE",
"USER_TYPE_ID": "integer",
"XML_ID": "UF_GRATITUDE",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"MIN_VALUE": 0,
"MAX_VALUE": 0,
"DEFAULT_VALUE": null
},
"EDIT_FORM_LABEL": null,
"LIST_COLUMN_LABEL": null,
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "integer",
"CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType",
"EDIT_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\IntegerType",
"renderEdit"
],
"VIEW_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\IntegerType",
"renderView"
],
"USE_FIELD_COMPONENT": true,
"DESCRIPTION": "Whole чandwithло",
"BASE_TYPE": "int"
},
"VALUE": null,
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"UF_BLOG_POST_FILE": {
"ID": "19",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_BLOG_POST_FILE",
"USER_TYPE_ID": "disk_file",
"XML_ID": "UF_BLOG_POST_FILE",
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": {
"IBLOCK_ID": null,
"SECTION_ID": null,
"UF_TO_SAVE_ALLOW_EDIT": false
},
"EDIT_FORM_LABEL": null,
"LIST_COLUMN_LABEL": null,
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "disk_file",
"CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType",
"DESCRIPTION": "File (Drive)",
"BASE_TYPE": "int",
"TAG": [
"DISK FILE ID",
"DOCUMENT ID"
]
},
"VALUE": [
74,
76
],
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": {
"PHOTO_TEMPLATE": ""
}
},
"UF_MAIL_MESSAGE": {
"ID": "75",
"ENTITY_ID": "BLOG_POST",
"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": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": null,
"EDIT_FORM_LABEL": null,
"LIST_COLUMN_LABEL": null,
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "mail_message",
"CLASS_NAME": "Bitrix\\Mail\\MessageUserType",
"DESCRIPTION": "Пandwithьмо (email)",
"BASE_TYPE": "int",
"VIEW_CALLBACK": [
"Bitrix\\Mail\\MessageUserType",
"getPublicView"
],
"EDIT_CALLBACK": [
"Bitrix\\Mail\\MessageUserType",
"getPublicEdit"
],
"onBeforeSave": [
"Bitrix\\Mail\\MessageUserType",
"onBeforeSave"
],
"onDelete": [
"Bitrix\\Mail\\MessageUserType",
"onDelete"
]
},
"VALUE": null,
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"UF_BLOG_POST_IMPRTNT": {
"ID": "93",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_BLOG_POST_IMPRTNT",
"USER_TYPE_ID": "integer",
"XML_ID": "UF_BLOG_POST_IMPRTNT",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"SIZE": 20,
"MIN_VALUE": 0,
"MAX_VALUE": 0,
"DEFAULT_VALUE": null
},
"EDIT_FORM_LABEL": "Important withобщенandе",
"LIST_COLUMN_LABEL": "Important",
"LIST_FILTER_LABEL": "Important",
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "integer",
"CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType",
"EDIT_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\IntegerType",
"renderEdit"
],
"VIEW_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\IntegerType",
"renderView"
],
"USE_FIELD_COMPONENT": true,
"DESCRIPTION": "Whole чandwithло",
"BASE_TYPE": "int"
},
"VALUE": null,
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"UF_IMPRTANT_DATE_END": {
"ID": "95",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_IMPRTANT_DATE_END",
"USER_TYPE_ID": "datetime",
"XML_ID": "UF_IMPRTANT_DATE_END",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"DEFAULT_VALUE": {
"TYPE": "NONE",
"VALUE": ""
},
"USE_SECOND": "Y",
"USE_TIMEZONE": "N"
},
"EDIT_FORM_LABEL": "Сроto дейwithтinandя",
"LIST_COLUMN_LABEL": "Сроto",
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "datetime",
"CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\DateTimeType",
"EDIT_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\DateTimeType",
"renderEdit"
],
"VIEW_CALLBACK": [
"Bitrix\\Main\\UserField\\Types\\DateTimeType",
"renderView"
],
"USE_FIELD_COMPONENT": true,
"DESCRIPTION": "Date with inремеnotм",
"BASE_TYPE": "datetime"
},
"VALUE": "",
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"UF_BLOG_POST_VOTE": {
"ID": "143",
"ENTITY_ID": "BLOG_POST",
"FIELD_NAME": "UF_BLOG_POST_VOTE",
"USER_TYPE_ID": "vote",
"XML_ID": "UF_BLOG_POST_VOTE",
"SORT": "100",
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"CHANNEL_ID": 1,
"UNIQUE": 8,
"UNIQUE_IP_DELAY": {
"DELAY": "10",
"DELAY_TYPE": "D"
},
"NOTIFY": "I"
},
"EDIT_FORM_LABEL": null,
"LIST_COLUMN_LABEL": null,
"LIST_FILTER_LABEL": null,
"ERROR_MESSAGE": null,
"HELP_MESSAGE": null,
"USER_TYPE": {
"USER_TYPE_ID": "vote",
"CLASS_NAME": "Bitrix\\Vote\\Uf\\VoteUserType",
"DESCRIPTION": "Poll",
"BASE_TYPE": "int"
},
"VALUE": null,
"ENTITY_VALUE_ID": 40,
"CUSTOM_DATA": []
},
"FILES": [
74,
76
]
}
],
"total": 1,
"time": {
"start": 1718304110.82197,
"finish": 1718304110.86041,
"duration": 0.0384387969970703,
"processing": 0.0108139514923096,
"date_start": "2024-06-13T18:41:50+00:00",
"date_finish": "2024-06-13T18:41:50+00:00",
"operating_reset_at": 1718304710,
"operating": 0
}
}
```

View File

@ -0,0 +1,70 @@
---
sidebar_position: 2
---
# Update post
Change post data
*Function UpdatePost(Val URL, Val PostID, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| PostID | --postid | String, Number | Post ID |
| Text | --text | String | Text of post |
| Visibility | --vision | String | Array or a single post target: UA all, SG<X> work group, U<X> user, DR<X> depart., G<X> group |
| Files | --files | String | Data inложенandй, где toлюч > name file, value > path to file andдand дinоandчные Data |
| Title | --title | String | Post title |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
Text = "New post text";
Title = "New post title";
Image1 = "https://openintegrations.dev/test_data/picture.jpg";
PostID = "124";
Files = New Map;
Files.Insert("1.png", Image1);
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text,, Files, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
PostID = "122";
Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text,, Files, Title, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdatePost --url "b24-ar17wx.bitrix24.by" --postid "122" --text %text% --vision %vision% --files %files% --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": 86,
"time": {
"start": 1718473311.53949,
"finish": 1718473311.89214,
"duration": 0.352643966674805,
"processing": 0.326650142669678,
"date_start": "2024-06-15T17:41:51+00:00",
"date_finish": "2024-06-15T17:41:51+00:00",
"operating_reset_at": 1718473911,
"operating": 0.326629877090454
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Feed posts managment",
"position": "3"
}

View File

@ -0,0 +1,36 @@
---
sidebar_position: 1
---
# Get app authentication link
Forms a link for authorization via the browser
*Function GetAppAuthLink(Val Domain, Val ClientID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Domain | --domain | String | Current Bitrix URL (like 'portal.bitrix24.com') |
| ClientID | --clientid | String | Client ID from app settings |
Returns: String - URL for browser transition
```bsl title="Code example"
```
```sh title="CLI command example"
oint bitrix24 GetAppAuthLink --domain %domain% --clientid %clientid%
```
```json title="Result"
"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732"
```

View File

@ -0,0 +1,44 @@
---
sidebar_position: 2
---
# Get token
Get token by auth code
*Function GetToken(Val ClientID, Val ClientSecret, Val Code) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| ClientID | --clientid | String | Client ID from app settings |
| ClientSecret | --clientsecret | String | Client secret from app settings |
| Code | --code | String | Code from browser auth page |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
ClientID = "local.6667fc928a50a9.70414732";
ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V...";
Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c";
Result = OPI_Bitrix24.GetToken(ClientID, ClientSecret, Code);
```
```sh title="CLI command example"
oint bitrix24 GetToken --clientid "local.6667fc928a50a9.70414732" --clientsecret "ZeKyeYIgy2NsHZqsIHY6GfG1V..." --code "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"
```
```json title="Result"
{
"error": "expired_token",
"error_description": "The authorization token provided has expired."
}
```

View File

@ -0,0 +1,53 @@
---
sidebar_position: 3
---
# Refresh token
Update token by refresh token
*Function RefreshToken(Val ClientID, Val ClientSecret, Val Refresh) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| ClientID | --clientid | String | Client ID from app settings |
| ClientSecret | --clientsecret | String | Client secret from app settings |
| Refresh | --refresh | String | Refresh token |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
ClientID = "local.6667fc928a50a9.70414732";
ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V...";
Refresh = "a95e9b66006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RefreshToken(ClientID, ClientSecret, Refresh);
```
```sh title="CLI command example"
oint bitrix24 RefreshToken --clientid "local.6667fc928a50a9.70414732" --clientsecret "ZeKyeYIgy2NsHZqsIHY6GfG1V..." --refresh "a95e9b66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"access_token": "63a46866006e9f06006b12e4000000010000071997e1f54c1043e9f7193734af3018df",
"expires": 1718133859,
"expires_in": 3600,
"scope": "app",
"domain": "oauth.bitrix.info",
"server_endpoint": "https://oauth.bitrix.info/rest/",
"status": "L",
"client_endpoint": "https://b24-ar17wx.bitrix24.by/rest/",
"member_id": "00168f0dd11ff00b4aeb8ce5befaa139",
"user_id": 1,
"refresh_token": "53239066006e9f06006b12e4000000010000078523b1fc75d58d6f0fa98b4632bc70ce"
}
```

View File

@ -0,0 +1,56 @@
---
sidebar_position: 4
---
# Server time
Get current server time
*Function ServerTime(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.ServerTime(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.ServerTime(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 ServerTime --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "2024-06-13T18:40:54+00:00",
"time": {
"start": 1718304054.57877,
"finish": 1718304054.71748,
"duration": 0.138707876205444,
"processing": 0.0000510215759277344,
"date_start": "2024-06-13T18:40:54+00:00",
"date_finish": "2024-06-13T18:40:54+00:00",
"operating_reset_at": 1718304654,
"operating": 0
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Settings and administartion",
"position": "2"
}

View File

@ -0,0 +1,51 @@
---
sidebar_position: 7
---
# Create folder at the storage
Create new foldera at the storage
*Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String | Storage ID |
| Name | --title | String | Folder name |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
StorageID = 3;
Name = "New catalog";
Filename2 = "New folder 2";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Filename2);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateStorageFolder --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
```

View File

@ -0,0 +1,59 @@
---
sidebar_position: 8
---
# Delete file
Delete file by ID
*Function DeleteFile(Val URL, Val FileID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | ID of removing file |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FileID = "488";
Result = OPI_Bitrix24.DeleteFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
FileID = "478";
Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFile --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718783933.86753,
"finish": 1718783937.64223,
"duration": 3.77469992637634,
"processing": 3.73617887496948,
"date_start": "2024-06-19T07:58:53+00:00",
"date_finish": "2024-06-19T07:58:57+00:00",
"operating_reset_at": 1718784533,
"operating": 3.73615193367004
}
}
```

View File

@ -0,0 +1,47 @@
---
sidebar_position: 9
---
# Delete folder
Remove folder with subfolders
*Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | ID of folder to be deleted |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FolderID = "480";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
FolderID = "482";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
```

View File

@ -0,0 +1,39 @@
---
sidebar_position: 2
---
# Get storage for application data
Get information about storage with which the application can work to store its data
*Function GetAppSotrage(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetAppSotrage(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetAppSotrage --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
```

View File

@ -0,0 +1,45 @@
---
sidebar_position: 5
---
# Get a list of child storage objects
Get a list of files and folders, located at the root of the storage
*Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
StorageID = 3;
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStorageObjects --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
```

View File

@ -0,0 +1,46 @@
---
sidebar_position: 3
---
# Get storage
Get information about storage
*Function GetStorage(Val URL, Val StorageID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
StorageID = 3;
Result = OPI_Bitrix24.GetStorage(URL, StorageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStorage --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
```

View File

@ -0,0 +1,120 @@
---
sidebar_position: 1
---
# Get list of storages
Get list of available files storages
*Function GetStoragesList(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetStoragesList(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStoragesList(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetStoragesList --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": [
{
"ID": "3",
"NAME": "Общandй дandwithto",
"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": "Toддержtoа Bitrix24",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "6",
"ROOT_OBJECT_ID": "70"
},
{
"ID": "14",
"NAME": "Марта",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "user",
"ENTITY_ID": "8",
"ROOT_OBJECT_ID": "72"
}
],
"total": 7,
"time": {
"start": 1718783911.64028,
"finish": 1718783911.69026,
"duration": 0.0499801635742188,
"processing": 0.00660109519958496,
"date_start": "2024-06-19T07:58:31+00:00",
"date_finish": "2024-06-19T07:58:31+00:00",
"operating_reset_at": 1718784511,
"operating": 0
}
}
```

View File

@ -0,0 +1,43 @@
---
sidebar_position: 4
---
# Rename storage
Change storage name (for app storage only, see. GetAppStorage)
*Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| StorageID | --storageid | String, Number | Storage ID |
| Name | --title | String | New storage name |
| Token | --token | String | Access token, when not-webhook method used |
Returns: HTTPResponse - Rename storage
```bsl title="Code example"
Name = "New storage name";
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
StorageID = "18";
Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token);
```
```sh title="CLI command example"
oint bitrix24 RenameStorage --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
```

View File

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

View File

@ -0,0 +1,4 @@
{
"label": "Storages and files managment",
"position": "5"
}

View File

@ -0,0 +1,59 @@
---
sidebar_position: 17
---
# Add task to favorites list
Add task to favorites list
*Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 AddTaskToFavorites --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718569733.98858,
"finish": 1718569734.02857,
"duration": 0.0399899482727051,
"processing": 0.00951814651489258,
"date_start": "2024-06-16T20:28:53+00:00",
"date_finish": "2024-06-16T20:28:54+00:00",
"operating_reset_at": 1718570334,
"operating": 0
}
}
```

View File

@ -0,0 +1,217 @@
---
sidebar_position: 7
---
# Approve task
Approve task by ID
*Function ApproveTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.ApproveTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.ApproveTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 ApproveTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"title": "Another task title",
"description": "Another task description",
"descriptionInBbcode": "Y",
"declineReason": "",
"priority": "1",
"notViewed": "N",
"statusComplete": "2",
"multitask": "N",
"stageId": "0",
"responsibleId": "1",
"responsibleName": "Anton",
"responsibleLastName": "Titovets",
"responsibleSecondName": null,
"responsibleLogin": "VKuser657846756",
"responsibleWorkPosition": null,
"responsiblePhoto": "30",
"dateStart": null,
"durationFact": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"replicate": "N",
"deadline": "2024-06-16T17:42:00+00:00",
"deadlineOrig": "16.06.2024 20:42:00",
"startDatePlan": null,
"endDatePlan": null,
"createdBy": "1",
"createdByName": "Anton",
"createdByLastName": "Titovets",
"createdBySecondName": null,
"createdByLogin": "VKuser657846756",
"createdByWorkPosition": null,
"createdByPhoto": "30",
"createdDate": "2024-06-15T17:42:04+00:00",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:17+00:00",
"statusChangedBy": "1",
"closedBy": "1",
"closedDate": "2024-06-15T17:42:17+00:00",
"activityDate": "2024-06-15T17:42:17+00:00",
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"mark": null,
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"matchWorkTime": "N",
"taskControl": "N",
"addInReport": "N",
"forumTopicId": "44",
"parentId": null,
"commentsCount": "1",
"serviceCommentsCount": "1",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "4",
"viewedDate": "2024-06-15T17:42:17+00:00",
"deadlineCounted": "0",
"forkedByTemplateId": null,
"sorting": null,
"durationPlanSeconds": null,
"durationTypeAll": "days",
"scenarioName": [
"default"
],
"isRegular": "N",
"flowId": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"ufCrmTask": false,
"ufTaskWebdavFiles": false,
"ufMailMessage": null,
"status": "5",
"statusChangedDate": "2024-06-15T17:42:17+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [],
"accomplices": [],
"tags": [],
"checklist": [],
"files": [],
"dependsOn": [],
"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": false,
"approve": false,
"disapprove": false,
"start": false,
"pause": false,
"delegate": false,
"remove": true,
"edit": true,
"defer": false,
"renew": true,
"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": 1718473338.92487,
"finish": 1718473338.9957,
"duration": 0.0708270072937012,
"processing": 0.0335841178894043,
"date_start": "2024-06-15T17:42:18+00:00",
"date_finish": "2024-06-15T17:42:18+00:00",
"operating_reset_at": 1718473938,
"operating": 0
}
}
```

View File

@ -0,0 +1,189 @@
---
sidebar_position: 9
---
# Complete task
Complete task by ID
*Function CompleteTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.CompleteTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.CompleteTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 CompleteTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:17+00:00",
"statusChangedBy": "1",
"closedBy": "1",
"closedDate": "2024-06-15T17:42:17+00:00",
"activityDate": "2024-06-15T17:42:17+00:00",
"dateStart": null,
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"commentsCount": "1",
"serviceCommentsCount": "1",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "44",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "4",
"viewedDate": "2024-06-15T17:42:17+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "5",
"statusChangedDate": "2024-06-15T17:42:17+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": false,
"approve": false,
"disapprove": false,
"start": false,
"pause": false,
"delegate": false,
"remove": true,
"edit": true,
"defer": false,
"renew": true,
"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": 1718473336.97976,
"finish": 1718473337.32391,
"duration": 0.344156980514526,
"processing": 0.312964200973511,
"date_start": "2024-06-15T17:42:16+00:00",
"date_finish": "2024-06-15T17:42:17+00:00",
"operating_reset_at": 1718473937,
"operating": 0.312941789627075
}
}
```

View File

@ -0,0 +1,202 @@
---
sidebar_position: 4
---
# Create task
Create new task by fields structure (see GetTaskFieldsStructure)
*Function CreateTask(Val URL, Val FieldsStructure, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldsStructure | --fields | Structure of Key-Value | Task fields structure |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
// The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function()
CurrentDate = OPI_Tools.GetCurrentDate();
Hour = 3600;
Day = 24;
Responsible = 1;
TaskData = New Structure;
TaskData.Insert("TITLE", "New task");
TaskData.Insert("DESCRIPTION", "New task description");
TaskData.Insert("PRIORITY", "2");
TaskData.Insert("DEADLINE", CurrentDate + Hour * Day);
TaskData.Insert("RESPONSIBLE_ID", Responsible);
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.CreateTask(URL, TaskData);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateTask(URL, TaskData, Token);
```
```sh title="CLI command example"
oint bitrix24 CreateTask --url "b24-ar17wx.bitrix24.by" --fields %fields% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"parentId": null,
"title": "New task",
"description": "New task description",
"mark": null,
"priority": "2",
"multitask": "N",
"notViewed": "N",
"replicate": "N",
"stageId": "0",
"createdBy": "1",
"createdDate": "2024-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:04+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-06-15T17:42:04+00:00",
"dateStart": null,
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"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": "1",
"viewedDate": null,
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-06-15T17:42:04+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": 1718473324.36745,
"finish": 1718473324.48918,
"duration": 0.121729135513306,
"processing": 0.0939490795135498,
"date_start": "2024-06-15T17:42:04+00:00",
"date_finish": "2024-06-15T17:42:04+00:00",
"operating_reset_at": 1718473924,
"operating": 0
}
}
```

View File

@ -0,0 +1,189 @@
---
sidebar_position: 11
---
# Defer task
Defer task by ID
*Function DeferTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.DeferTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.DeferTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeferTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:14+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-15T17:42:04+00:00",
"dateStart": null,
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"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": "3",
"viewedDate": null,
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "6",
"statusChangedDate": "2024-06-15T17:42:14+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": false,
"pause": false,
"delegate": true,
"remove": true,
"edit": true,
"defer": false,
"renew": true,
"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": 1718473334.90661,
"finish": 1718473335.06708,
"duration": 0.160465955734253,
"processing": 0.131988048553467,
"date_start": "2024-06-15T17:42:14+00:00",
"date_finish": "2024-06-15T17:42:15+00:00",
"operating_reset_at": 1718473934,
"operating": 0.131969928741455
}
}
```

View File

@ -0,0 +1,201 @@
---
sidebar_position: 16
---
# Delegate task
Delegate task to another user
*Function DelegateTask(Val URL, Val TaskID, Val UserID, 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 |
| UserID | --user | Number, String | ID of responsible user |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
UserID = "10";
Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID, Token);
```
```sh title="CLI command example"
oint bitrix24 DelegateTask --url "b24-ar17wx.bitrix24.by" --task "170" --user "10" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "154",
"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-06-19T07:57:54+00:00",
"responsibleId": "10",
"changedBy": "1",
"changedDate": "2024-06-19T07:58:08+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-19T07:58:08+00:00",
"dateStart": null,
"deadline": "2024-06-20T07:57:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{ad8a4659-17d0-45d1-9b6d-215cf345ae56}",
"xmlId": null,
"commentsCount": "1",
"serviceCommentsCount": "1",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "142",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "3",
"viewedDate": "2024-06-19T07:58:09+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-06-19T07:58:08+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [
"1"
],
"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": "10",
"name": "Techno Pizza",
"link": "/company/personal/user/10/",
"icon": "/bitrix/images/tasks/default_avatar.png",
"workPosition": null
},
"accomplicesData": [],
"auditorsData": {
"1": {
"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
}
},
"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": 1718783888.64547,
"finish": 1718783889.13128,
"duration": 0.485809803009033,
"processing": 0.450714111328125,
"date_start": "2024-06-19T07:58:08+00:00",
"date_finish": "2024-06-19T07:58:09+00:00",
"operating_reset_at": 1718784488,
"operating": 0.450687170028686
}
}
```

View File

@ -0,0 +1,61 @@
---
sidebar_position: 6
---
# Delete task
Delete task by ID
*Function DeleteTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.DeleteTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.DeleteTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": true
},
"time": {
"start": 1718473350.68409,
"finish": 1718473350.80999,
"duration": 0.125902891159058,
"processing": 0.0892560482025146,
"date_start": "2024-06-15T17:42:30+00:00",
"date_finish": "2024-06-15T17:42:30+00:00",
"operating_reset_at": 1718473950,
"operating": 0
}
}
```

View File

@ -0,0 +1,50 @@
---
sidebar_position: 8
---
# Disapprove task
Disapprove task by ID
*Function DisapproveTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.DisapproveTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.DisapproveTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 DisapproveTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"error": 1048582,
"error_description": "Action toд задачей not разрешеbut"
}
```

View File

@ -0,0 +1,35 @@
---
sidebar_position: 22
---
# Get structure of comments filter
Return filter structure for GetTaskCommentsList
*Function GetCommentsFilterStructure(Val Clear = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of Key-Value - Fields structure
```bsl title="Code example"
```
```sh title="CLI command example"
oint bitrix24 GetCommentsFilterStructure --empty %empty%
```
```json title="Result"
```

View File

@ -0,0 +1,38 @@
---
sidebar_position: 20
---
# Get comments list for a task
Get user comments list for a task
*Function GetTaskCommentsList(Val URL, Val TaskID, Val Filter = "", 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 |
| Filter | --filter | Structure of Key-Value | Comments filter structure (see GetCommentsFilterStructure) |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
```
```sh title="CLI command example"
oint bitrix24 GetTaskCommentsList --url %url% --task %task% --filter %filter% --token %token%
```
```json title="Result"
```

View File

@ -0,0 +1,424 @@
---
sidebar_position: 1
---
# Get task fields structure
Gets a structure with a description of the fields for creating a task
*Function GetTaskFieldsStructure(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetTaskFieldsStructure(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTaskFieldsStructure --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"fields": {
"ID": {
"title": "ID",
"type": "integer",
"primary": true
},
"PARENT_ID": {
"title": "ID базоinой of topic",
"type": "integer",
"default": 0
},
"TITLE": {
"title": "Name",
"type": "string",
"required": true
},
"DESCRIPTION": {
"title": "Description",
"type": "string"
},
"MARK": {
"title": "Оценtoа",
"type": "enum",
"values": {
"N": "Оthreeцательtoя",
"P": "Toложandтельtoя"
},
"default": null
},
"PRIORITY": {
"title": "Прandорandтет",
"type": "enum",
"values": {
"2": "Inыwithtoandй",
"1": "Midнandй",
"0": "Nfromtoandй"
},
"default": 1
},
"STATUS": {
"title": "Status",
"type": "enum",
"values": {
"2": "Ждет of completing",
"3": "Inыtoлняетwithя",
"4": "Ожandдает toонтроля",
"5": "Заinершеto",
"6": "Отложеto"
},
"default": 2
},
"MULTITASK": {
"title": "Мbutжеwithтinенtoя task",
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"NOT_VIEWED": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"REPLICATE": {
"title": "Toinторяемая task",
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"GROUP_ID": {
"title": "Проеtoт",
"type": "integer",
"default": 0
},
"STAGE_ID": {
"title": "Стадandя",
"type": "integer",
"default": 0
},
"CREATED_BY": {
"title": "Postаbutinщandto",
"type": "integer",
"required": true
},
"CREATED_DATE": {
"title": null,
"type": "datetime"
},
"RESPONSIBLE_ID": {
"title": "Responsible",
"type": "integer",
"required": true
},
"ACCOMPLICES": {
"title": null,
"type": "array"
},
"AUDITORS": {
"title": null,
"type": "array"
},
"CHANGED_BY": {
"title": "Inменandл",
"type": "integer"
},
"CHANGED_DATE": {
"title": "Date change",
"type": "datetime"
},
"STATUS_CHANGED_BY": {
"title": "Inменandл status",
"type": "integer"
},
"STATUS_CHANGED_DATE": {
"title": "Date change of status",
"type": "datetime"
},
"CLOSED_BY": {
"title": "Заtoрыл задачу",
"type": "integer",
"default": null
},
"CLOSED_DATE": {
"title": "Date заtoрытandя",
"type": "datetime",
"default": null
},
"ACTIVITY_DATE": {
"title": null,
"type": "datetime",
"default": null
},
"DATE_START": {
"title": "Date of start",
"type": "datetime",
"default": null
},
"DEADLINE": {
"title": "Kрайнandй deadline",
"type": "datetime",
"default": null
},
"START_DATE_PLAN": {
"title": "Плаbutinое toчало",
"type": "datetime",
"default": null
},
"END_DATE_PLAN": {
"title": "Плаbutinое заinершенandе",
"type": "datetime",
"default": null
},
"GUID": {
"title": "GUID",
"type": "string",
"default": null
},
"XML_ID": {
"title": "XML_ID",
"type": "string",
"default": null
},
"COMMENTS_COUNT": {
"title": "Kол-inо toомментарandеin",
"type": "integer",
"default": 0
},
"SERVICE_COMMENTS_COUNT": {
"title": null,
"type": "integer",
"default": 0
},
"NEW_COMMENTS_COUNT": {
"title": null,
"type": "integer",
"default": 0
},
"ALLOW_CHANGE_DEADLINE": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"ALLOW_TIME_TRACKING": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"TASK_CONTROL": {
"title": "Прandнять работу",
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"ADD_IN_REPORT": {
"title": "Add in отчет",
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"FORKED_BY_TEMPLATE_ID": {
"title": "Создаbut from шаблоto",
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"TIME_ESTIMATE": {
"title": "Затрачеbutе inремя",
"type": "integer"
},
"TIME_SPENT_IN_LOGS": {
"title": "Затрачеbutе inремя from andwithторandand changedandй",
"type": "integer"
},
"MATCH_WORK_TIME": {
"title": "Skip inыходные днand",
"type": "integer"
},
"FORUM_TOPIC_ID": {
"title": "FORUM_TOPIC_ID",
"type": "integer"
},
"FORUM_ID": {
"title": "FORUM_ID",
"type": "integer"
},
"SITE_ID": {
"title": "SITE_ID",
"type": "string"
},
"SUBORDINATE": {
"title": "Задача toдчandnotнbutго",
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": null
},
"FAVORITE": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": null
},
"EXCHANGE_MODIFIED": {
"title": "EXCHANGE_MODIFIED",
"type": "datetime",
"default": null
},
"EXCHANGE_ID": {
"title": "EXCHANGE_ID",
"type": "integer",
"default": null
},
"OUTLOOK_VERSION": {
"title": "OUTLOOK_VERSION",
"type": "integer",
"default": null
},
"VIEWED_DATE": {
"title": "Date of last проwithмотра",
"type": "datetime"
},
"SORTING": {
"title": "Andндеtowith of sorting",
"type": "double"
},
"DURATION_PLAN": {
"title": "Затрачеbut (план)",
"type": "integer"
},
"DURATION_FACT": {
"title": "Затрачеbut (фаtoтandчеwithtoand)",
"type": "integer"
},
"CHECKLIST": {
"title": null,
"type": "array"
},
"DURATION_TYPE": {
"title": "DURATION_TYPE",
"type": "enum",
"values": [
"secs",
"mins",
"hours",
"days",
"weeks",
"monts",
"years"
],
"default": "days"
},
"IS_MUTED": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"IS_PINNED": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"IS_PINNED_IN_GROUP": {
"title": null,
"type": "enum",
"values": {
"Y": "Да",
"N": "No"
},
"default": "N"
},
"FLOW_ID": {
"title": null,
"type": "integer",
"default": 0
},
"UF_CRM_TASK": {
"title": "Items CRM",
"type": "crm"
},
"UF_TASK_WEBDAV_FILES": {
"title": "Load files",
"type": "disk_file"
},
"UF_MAIL_MESSAGE": {
"title": null,
"type": "mail_message"
}
}
},
"time": {
"start": 1718473322.5296,
"finish": 1718473322.56673,
"duration": 0.0371248722076416,
"processing": 0.00164389610290527,
"date_start": "2024-06-15T17:42:02+00:00",
"date_finish": "2024-06-15T17:42:02+00:00",
"operating_reset_at": 1718473922,
"operating": 0
}
}
```

View File

@ -0,0 +1,302 @@
---
sidebar_position: 19
---
# Get task history
Get history of task changing
*Function GetTaskHistory(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTaskHistory --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"list": [
{
"id": "1044",
"createdDate": "19.06.2024 10:57:54",
"field": "NEW",
"value": {
"from": null,
"to": null
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1052",
"createdDate": "19.06.2024 10:58:01",
"field": "TITLE",
"value": {
"from": "New task",
"to": "Another task title"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1054",
"createdDate": "19.06.2024 10:58:01",
"field": "DESCRIPTION",
"value": {
"from": "",
"to": ""
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1056",
"createdDate": "19.06.2024 10:58:01",
"field": "PRIORITY",
"value": {
"from": "2",
"to": "1"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1064",
"createdDate": "19.06.2024 10:58:08",
"field": "RESPONSIBLE_ID",
"value": {
"from": "1",
"to": "10"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1066",
"createdDate": "19.06.2024 10:58:08",
"field": "AUDITORS",
"value": {
"from": "",
"to": "1"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1068",
"createdDate": "19.06.2024 10:58:08",
"field": "COMMENT",
"value": {
"from": null,
"to": "406"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1072",
"createdDate": "19.06.2024 10:58:10",
"field": "STATUS",
"value": {
"from": "2",
"to": "6"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1078",
"createdDate": "19.06.2024 10:58:12",
"field": "STATUS",
"value": {
"from": "6",
"to": "5"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1080",
"createdDate": "19.06.2024 10:58:12",
"field": "COMMENT",
"value": {
"from": null,
"to": "410"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1086",
"createdDate": "19.06.2024 10:58:16",
"field": "STATUS",
"value": {
"from": "5",
"to": "2"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1088",
"createdDate": "19.06.2024 10:58:17",
"field": "COMMENT",
"value": {
"from": null,
"to": "414"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1092",
"createdDate": "19.06.2024 10:58:18",
"field": "STATUS",
"value": {
"from": "2",
"to": "3"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1096",
"createdDate": "19.06.2024 10:58:22",
"field": "AUDITORS",
"value": {
"from": "1",
"to": ""
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
},
{
"id": "1100",
"createdDate": "19.06.2024 10:58:23",
"field": "STATUS",
"value": {
"from": "3",
"to": "2"
},
"user": {
"id": "1",
"name": "Anton",
"lastName": "Titovets",
"secondName": null,
"login": "VKuser657846756"
}
}
]
},
"time": {
"start": 1718783905.33427,
"finish": 1718783905.37664,
"duration": 0.0423648357391357,
"processing": 0.00563311576843262,
"date_start": "2024-06-19T07:58:25+00:00",
"date_finish": "2024-06-19T07:58:25+00:00",
"operating_reset_at": 1718784505,
"operating": 0
}
}
```

View File

@ -0,0 +1,189 @@
---
sidebar_position: 2
---
# Get task
Get task by ID
*Function GetTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.GetTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.GetTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:11+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-06-15T17:42:04+00:00",
"dateStart": null,
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"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-06-15T17:42:11+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": 1718473333.14793,
"finish": 1718473333.22076,
"duration": 0.072829008102417,
"processing": 0.0298500061035156,
"date_start": "2024-06-15T17:42:13+00:00",
"date_finish": "2024-06-15T17:42:13+00:00",
"operating_reset_at": 1718473933,
"operating": 0
}
}
```

View File

@ -0,0 +1,35 @@
---
sidebar_position: 21
---
# Get structure of tasks filter
Return filter structure for GetTasksList
*Function GetTasksFilterStructure(Val Clear = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Clear | --empty | Boolean | True > structure with empty valuse, False > field descriptions at values |
Returns: Structure of Key-Value - Fields structure
```bsl title="Code example"
```
```sh title="CLI command example"
oint bitrix24 GetTasksFilterStructure --empty %empty%
```
```json title="Result"
```

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,189 @@
---
sidebar_position: 12
---
# Pause task
Pause a task by ID
*Function PauseTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.PauseTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.PauseTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 PauseTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:28+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-15T17:42:25+00:00",
"dateStart": "2024-06-15T17:42:22+00:00",
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"commentsCount": "3",
"serviceCommentsCount": "3",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "44",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "9",
"viewedDate": "2024-06-15T17:42:25+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-06-15T17:42:28+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": 1718473348.81627,
"finish": 1718473349.00917,
"duration": 0.192903995513916,
"processing": 0.149300098419189,
"date_start": "2024-06-15T17:42:28+00:00",
"date_finish": "2024-06-15T17:42:29+00:00",
"operating_reset_at": 1718473948,
"operating": 0.149271011352539
}
}
```

View File

@ -0,0 +1,59 @@
---
sidebar_position: 18
---
# Remove task from favorites list
Delete task from favorites list
*Function RemoveTaskFromFavorites(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 RemoveTaskFromFavorites --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1718569735.08926,
"finish": 1718569735.1282,
"duration": 0.0389459133148193,
"processing": 0.00808191299438476,
"date_start": "2024-06-16T20:28:55+00:00",
"date_finish": "2024-06-16T20:28:55+00:00",
"operating_reset_at": 1718570335,
"operating": 0
}
}
```

View File

@ -0,0 +1,189 @@
---
sidebar_position: 10
---
# Renew task
Returns a task to work by ID
*Function RenewTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.RenewTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.RenewTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 RenewTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:20+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-15T17:42:21+00:00",
"dateStart": null,
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"commentsCount": "2",
"serviceCommentsCount": "2",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "44",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "5",
"viewedDate": "2024-06-15T17:42:21+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "2",
"statusChangedDate": "2024-06-15T17:42:20+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": 1718473340.85177,
"finish": 1718473341.14434,
"duration": 0.292572021484375,
"processing": 0.261486768722534,
"date_start": "2024-06-15T17:42:20+00:00",
"date_finish": "2024-06-15T17:42:21+00:00",
"operating_reset_at": 1718473940,
"operating": 0.26146388053894
}
}
```

View File

@ -0,0 +1,189 @@
---
sidebar_position: 13
---
# Start a task
Start a task by ID
*Function StartTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.StartTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.StartTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 StartTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:22+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-15T17:42:21+00:00",
"dateStart": "2024-06-15T17:42:22+00:00",
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"commentsCount": "2",
"serviceCommentsCount": "2",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "44",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "6",
"viewedDate": "2024-06-15T17:42:21+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "3",
"statusChangedDate": "2024-06-15T17:42:22+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": false,
"pause": true,
"delegate": true,
"remove": true,
"edit": true,
"defer": false,
"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": 1718473342.85609,
"finish": 1718473343.03046,
"duration": 0.174365997314453,
"processing": 0.140038967132568,
"date_start": "2024-06-15T17:42:22+00:00",
"date_finish": "2024-06-15T17:42:23+00:00",
"operating_reset_at": 1718473942,
"operating": 0.14000415802002
}
}
```

View File

@ -0,0 +1,199 @@
---
sidebar_position: 14
---
# Start watching a task
Start watching a task by ID
*Function StartWatchingTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.StartWatchingTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 StartWatchingTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:24+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-15T17:42:25+00:00",
"dateStart": "2024-06-15T17:42:22+00:00",
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"commentsCount": "3",
"serviceCommentsCount": "3",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "44",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "7",
"viewedDate": "2024-06-15T17:42:25+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "3",
"statusChangedDate": "2024-06-15T17:42:22+00:00",
"durationPlan": null,
"durationType": "days",
"favorite": "N",
"groupId": "0",
"auditors": [
"1"
],
"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": {
"1": {
"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
}
},
"newCommentsCount": 0,
"action": {
"accept": false,
"decline": false,
"complete": true,
"approve": false,
"disapprove": false,
"start": false,
"pause": true,
"delegate": true,
"remove": true,
"edit": true,
"defer": false,
"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": 1718473344.8384,
"finish": 1718473345.165,
"duration": 0.326602935791016,
"processing": 0.279624938964844,
"date_start": "2024-06-15T17:42:24+00:00",
"date_finish": "2024-06-15T17:42:25+00:00",
"operating_reset_at": 1718473944,
"operating": 0.279598951339722
}
}
```

View File

@ -0,0 +1,189 @@
---
sidebar_position: 15
---
# Stop watching the task
Stop watching a task by ID
*Function StopWatchingTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.StopWatchingTask(URL, TaskID, Token);
```
```sh title="CLI command example"
oint bitrix24 StopWatchingTask --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:26+00:00",
"statusChangedBy": "1",
"closedBy": "0",
"closedDate": null,
"activityDate": "2024-06-15T17:42:25+00:00",
"dateStart": "2024-06-15T17:42:22+00:00",
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"xmlId": null,
"commentsCount": "3",
"serviceCommentsCount": "3",
"allowChangeDeadline": "N",
"allowTimeTracking": "N",
"taskControl": "N",
"addInReport": "N",
"forkedByTemplateId": null,
"timeEstimate": "0",
"timeSpentInLogs": null,
"matchWorkTime": "N",
"forumTopicId": "44",
"forumId": "11",
"siteId": "s1",
"subordinate": "N",
"exchangeModified": null,
"exchangeId": null,
"outlookVersion": "8",
"viewedDate": "2024-06-15T17:42:25+00:00",
"sorting": null,
"durationFact": null,
"isMuted": "N",
"isPinned": "N",
"isPinnedInGroup": "N",
"flowId": null,
"descriptionInBbcode": "Y",
"status": "3",
"statusChangedDate": "2024-06-15T17:42:22+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": false,
"pause": true,
"delegate": true,
"remove": true,
"edit": true,
"defer": false,
"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": 1718473346.90101,
"finish": 1718473347.11313,
"duration": 0.212116003036499,
"processing": 0.175701141357422,
"date_start": "2024-06-15T17:42:26+00:00",
"date_finish": "2024-06-15T17:42:27+00:00",
"operating_reset_at": 1718473946,
"operating": 0.175670862197876
}
}
```

View File

@ -0,0 +1,197 @@
---
sidebar_position: 5
---
# Update task
Update a task
*Function UpdateTask(Val URL, Val TaskID, Val FieldsStructure, 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 |
| FieldsStructure | --fields | Structure of Key-Value | Task fields structure |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
// The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function()
TaskData = New Structure;
TaskData.Insert("TITLE", "Another task title");
TaskData.Insert("DESCRIPTION", "Another task description");
TaskData.Insert("PRIORITY", "1");
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168";
Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
TaskID = "170";
Result = OPI_Bitrix24.UpdateTask(URL, TaskID, TaskData, Token);
```
```sh title="CLI command example"
oint bitrix24 UpdateTask --url "b24-ar17wx.bitrix24.by" --task "170" --fields %fields% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"task": {
"id": "110",
"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-06-15T17:42:04+00:00",
"responsibleId": "1",
"changedBy": "1",
"changedDate": "2024-06-15T17:42:11+00:00",
"statusChangedBy": null,
"closedBy": null,
"closedDate": null,
"activityDate": "2024-06-15T17:42:04+00:00",
"dateStart": null,
"deadline": "2024-06-16T17:42:00+00:00",
"startDatePlan": null,
"endDatePlan": null,
"guid": "{8d5b2535-b856-4da0-8e67-df7eb35c1add}",
"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-06-15T17:42:11+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": 1718473331.25688,
"finish": 1718473331.49812,
"duration": 0.2412428855896,
"processing": 0.20207691192627,
"date_start": "2024-06-15T17:42:11+00:00",
"date_finish": "2024-06-15T17:42:11+00:00",
"operating_reset_at": 1718473931,
"operating": 0.202054023742676
}
}
```

View File

@ -0,0 +1,4 @@
{
"label": "Tasks managment",
"position": "4"
}

View File

@ -36,6 +36,20 @@ sidebar_position: 9
```json title="Result"
{
"metadata": {
".tag": "file",
"name": "pic.png",
"path_lower": "/pic.png",
"path_display": "/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAAFJA",
"client_modified": "2024-06-11T18:24:16Z",
"server_modified": "2024-06-11T18:24:57Z",
"rev": "61aa16214d7c6bd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

View File

@ -37,6 +37,23 @@ sidebar_position: 3
```json title="Result"
[
{
"member": {
".tag": "email",
"email": "h5bk6ft62s@privaterelay.appleid.com"
},
"result": {
".tag": "success",
"success": {
".tag": "editor"
}
},
"sckey_sha1": "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4",
"invitation_signature": [
"ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4:ed7721b375882c806612d4056dad9f317cc98a22"
]
}
]
```

View File

@ -37,6 +37,6 @@ sidebar_position: 4
```json title="Result"
{}
```

View File

@ -18,7 +18,13 @@ sidebar_position: 1
```bsl title="Code example"
Token = "sl.B22821SXrkmxs9KAaC6M_ax_M33mEcEvKz9sqgcMO8Xwn0bvpx4_57UQqLR_gEuPS_Yk5yd3Tv...";
PathsArray = New Array;
PathsArray.Add("/New/Dogs.mp3");
PathsArray.Add("/New/mydoc.docx");
Result = OPI_Dropbox.GetTagList(Token, PathsArray);
```

View File

@ -2,8 +2,8 @@
sidebar_position: 2
---
# Return block.
# Return block
Returns the block structure by ID
*Function ReturnBlock(Val Token, Val BlockID, Val OnlyBase = True) Export*

View File

@ -2,8 +2,8 @@
sidebar_position: 4
---
# Edit page properties.
# Edit page properties
Changes the properties of an existing page
*Function EditPageProperties(Val Token, Val Page, Val Data = "", Val Icon = "", Val Cover = "", Val Archived = False) Export*

View File

@ -0,0 +1,44 @@
---
sidebar_position: 7
---
# Delete message
Delete message from chat or channel
*Function DeleteMessage(Val Token, Val ChatID, Val MessageID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| ChatID | --chat | String, Number | Target chat ID |
| MessageID | --message | String, Number | ID of message to delete |
Returns: Map Of KeyAndValue - Serialized JSON response from Telegram
```bsl title="Code example"
Token = "6129457865:AAFyzNYOAFbu...";
ChatID = "@testsichee";
MessageID = "5385";
Result = OPI_Telegram.DeleteMessage(Token, ChatID, MessageID);
```
```sh title="CLI command example"
oint telegram DeleteMessage --token "6129457865:AAFyzNYOAFbu..." --chat "@testsichee" --message "5385"
```
```json title="Result"
{
"ok": true,
"result": true
}
```

View File

@ -6,7 +6,7 @@ sidebar_position: 1
Sends a text message to a chat or channel
*Function SendTextMessage(Val Token, Val ChatID, Val Text, Val Keyboard = "", Val Markup = "Markdown") Export*
*Function SendTextMessage(Val Token, Val ChatID, Val Text, Val Keyboard = "", Val Markup = "Markdown", Val RepliedID = 0) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
@ -15,6 +15,7 @@ sidebar_position: 1
| Text | --text | String | Message text |
| Keyboard | --keyboard | String | Keyboard JSON or path to .json |
| Markup | --parsemode | String | Text processing type (HTML, Markdown, MarkdownV2) |
| RepliedID | --reply | String, Number | Reply to message ID |
Returns: Map Of KeyAndValue - Serialized JSON response from Telegram

View File

@ -0,0 +1 @@
oint bitrix24 ВозобновитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ДелегироватьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --user "10" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ДобавитьЗадачуВИзбранное --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ДобавитьКомментарий --url "b24-ar17wx.bitrix24.by" --postid "124" --text %text% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ДобавитьПолучателейКНовости --url "b24-ar17wx.bitrix24.by" --postid "124" --vision %vision% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ЗавершитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ЗагрузитьФайлВХранилище --url "b24-ar17wx.bitrix24.by" --title %title% --file %file% --storageid %storageid% --rights %rights% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ИзменитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --fields %fields% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ИзменитьНовость --url "b24-ar17wx.bitrix24.by" --postid "122" --text %text% --vision %vision% --files %files% --title %title% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 НачатьВыполнениеЗадачи --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 НачатьНаблюдатьЗаЗадачей --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ОбновитьТокен --clientid "local.6667fc928a50a9.70414732" --clientsecret "ZeKyeYIgy2NsHZqsIHY6GfG1V..." --refresh "a95e9b66006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ОтклонитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ОтложитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПереименоватьХранилище --url "b24-ar17wx.bitrix24.by" --storageid "18" --title %title% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьИсториюЗадачи --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьНовости --url "b24-ar17wx.bitrix24.by" --postid "124" --sel %sel% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСодержимоеХранилища --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСписокЗадач --url "b24-ar17wx.bitrix24.by" --filter %filter% --offset %offset% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСписокКомментариевЗадачи --url %url% --task %task% --filter %filter% --token %token%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСписокПросмотревшихВажное --url "b24-ar17wx.bitrix24.by" --postid "122" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСписокХранилищ --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСсылкуАвторизацииПриложения --domain %domain% --clientid %clientid%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтруктуруЗадачи --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтруктуруФильтраЗадач --empty %empty%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьСтруктуруФильтраКомментариев --empty %empty%

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьТокен --clientid "local.6667fc928a50a9.70414732" --clientsecret "ZeKyeYIgy2NsHZqsIHY6GfG1V..." --code "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПолучитьХранилищеПриложения --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПрекратитьНаблюдатьЗаЗадачей --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПринятьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 ПриостановитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 СерверноеВремя --url "b24-ar17wx.bitrix24.by" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 СоздатьЗадачу --url "b24-ar17wx.bitrix24.by" --fields %fields% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 СоздатьКаталогВХранилище --url "b24-ar17wx.bitrix24.by" --storageid %storageid% --title %title% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 СоздатьНовость --url "b24-ar17wx.bitrix24.by" --text %text% --vision %vision% --files %files% --title %title% --important %important% --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 УбратьЗадачуИзИзбранного --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 УдалитьЗадачу --url "b24-ar17wx.bitrix24.by" --task "170" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 УдалитьКаталог --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 УдалитьНовость --url "b24-ar17wx.bitrix24.by" --postid "124" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint bitrix24 УдалитьФайл --url "b24-ar17wx.bitrix24.by" --fileid "478" --token "b9df7366006e9f06006b12e400000001000..."

View File

@ -0,0 +1 @@
oint telegram УдалитьСообщение --token "6129457865:AAFyzNYOAFbu..." --chat "@testsichee" --message "5385"

View File

@ -0,0 +1,60 @@
---
sidebar_position: 7
---
# Добавить получателей к новости
Добавляет новые группы или пользователей в получатели
*Функция ДобавитьПолучателейКНовости(Знач URL, Знач IDНовости, Знач Видимость, Знач Токен = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
| IDНовости | --postid | Строка, Число | ID новости |
| Видимость | --vision | Строка | Массив|Один получатель: UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа |
| Токен | --token | Строка | Токен авторизации, если используется не вебхук |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24
```bsl title="Пример кода"
Видимость = "UA";
IDНовости = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость);
URL = "b24-ar17wx.bitrix24.by";
Токен = "b9df7366006e9f06006b12e400000001000...";
Результат = OPI_Bitrix24.ДобавитьПолучателейКНовости(URL, IDНовости, Видимость, Токен);
```
```sh title="Пример команды CLI"
oint bitrix24 ДобавитьПолучателейКНовости --url "b24-ar17wx.bitrix24.by" --postid "124" --vision %vision% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Результат"
{
"result": true,
"time": {
"start": 1718473318.17435,
"finish": 1718473318.21352,
"duration": 0.0391781330108643,
"processing": 0.00464105606079102,
"date_start": "2024-06-15T17:41:58+00:00",
"date_finish": "2024-06-15T17:41:58+00:00",
"operating_reset_at": 1718473918,
"operating": 0
}
}
```

View File

@ -0,0 +1,61 @@
---
sidebar_position: 6
---
# Добавить комментарий
Добавляет комментарий к новости
*Функция ДобавитьКомментарий(Знач URL, Знач IDНовости, Знач Текст, Знач Токен = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
| IDНовости | --postid | Строка, Число | ID новости |
| Текст | --text | Строка | Текст комментария |
| Токен | --token | Строка | Токен авторизации, если используется не вебхук |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24
```bsl title="Пример кода"
Текст = "Комментарий к новости";
IDНовости = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Результат = OPI_Bitrix24.ДобавитьКомментарий(URL, IDНовости, Текст);
Текст = "Другой комментарий к новости";
URL = "b24-ar17wx.bitrix24.by";
Токен = "b9df7366006e9f06006b12e400000001000...";
Результат = OPI_Bitrix24.ДобавитьКомментарий(URL, IDНовости, Текст, Токен);
```
```sh title="Пример команды CLI"
oint bitrix24 ДобавитьКомментарий --url "b24-ar17wx.bitrix24.by" --postid "124" --text %text% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Результат"
{
"result": 24,
"time": {
"start": 1718473316.57246,
"finish": 1718473316.67595,
"duration": 0.103492975234985,
"processing": 0.0729200839996338,
"date_start": "2024-06-15T17:41:56+00:00",
"date_finish": "2024-06-15T17:41:56+00:00",
"operating_reset_at": 1718473916,
"operating": 0
}
}
```

View File

@ -0,0 +1,71 @@
---
sidebar_position: 1
---
# Создать новость
Создает новую новость в ленте
*Функция СоздатьНовость(Знач URL, Знач Текст, Знач Видимость = "UA", Знач Файлы = "", Знач Заголовок = "", Знач Важное = Ложь, Знач Токен = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
| Текст | --text | Строка | Текст новости |
| Видимость | --vision | Строка | Массив|Один получатель: UA все, SGn раб. группа, Un пользователь, DRn отдел, Gn группа |
| Файлы | --files | Строка | Данные вложений, где ключ > имя файла, значение > путь к файлу иди двоичные данные |
| Заголовок | --title | Строка | Заголовок новости |
| Важное | --important | Булево | Помечает новость как важную |
| Токен | --token | Строка | Токен авторизации, если используется не вебхук |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrxi24
```bsl title="Пример кода"
Текст = "Текст новости";
Заголовок = "Заголовок новости";
Картинка1 = "https://openintegrations.dev/test_data/picture.jpg";
Картинка2 = "https://openintegrations.dev/test_data/picture2.jpg";
Файлы = Новый Соответствие;
Файлы.Вставить("1.png", Картинка1);
Файлы.Вставить("2.png", Картинка2);
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, Истина);
URL = "b24-ar17wx.bitrix24.by";
Токен = "b9df7366006e9f06006b12e400000001000...";
Результат = OPI_Bitrix24.СоздатьНовость(URL, Текст, , Файлы, Заголовок, , Токен);
```
```sh title="Пример команды CLI"
oint bitrix24 СоздатьНовость --url "b24-ar17wx.bitrix24.by" --text %text% --vision %vision% --files %files% --title %title% --important %important% --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Результат"
{
"result": 18,
"time": {
"start": 1718130364.82176,
"finish": 1718130365.61903,
"duration": 0.797268867492676,
"processing": 0.63801383972168,
"date_start": "2024-06-11T18:26:04+00:00",
"date_finish": "2024-06-11T18:26:05+00:00",
"operating_reset_at": 1718130964,
"operating": 0.637988090515137
}
}
```

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