1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-25 02:42:28 +02:00

Дополнение доков по B24

This commit is contained in:
Anton Titovets 2024-07-10 11:59:55 +03:00
parent 0ff2e321c8
commit 3e9b966df2
825 changed files with 13405 additions and 3686 deletions

View File

@ -176,7 +176,12 @@
РазбитоеЗначение = СтрРазделить(Текст, "=", Ложь); РазбитоеЗначение = СтрРазделить(Текст, "=", Ложь);
ИмяПараметра = ОпределитьИмяПараметра(Текст); ИмяПараметра = ОпределитьИмяПараметра(Текст);
Значение = OPI_ПолучениеДанныхТестов.ПолучитьПараметр(ИмяПараметра);
Попытка
Значение = OPI_ПолучениеДанныхТестов.ПолучитьПараметр(ИмяПараметра);
Исключение
Возврат Текст;
КонецПопытки;
ЗакрытьСекретныеДанные(Значение, ИмяПараметра); ЗакрытьСекретныеДанные(Значение, ИмяПараметра);

View File

@ -143,6 +143,7 @@
Макет = СтрЗаменить(Макет, "@Объявление" , СтруктураМетода["Объявление"]); Макет = СтрЗаменить(Макет, "@Объявление" , СтруктураМетода["Объявление"]);
Макет = СтрЗаменить(Макет, "@ВозвращаемоеЗначение", СтруктураМетода["ВозвращаемоеЗначение"]); Макет = СтрЗаменить(Макет, "@ВозвращаемоеЗначение", СтруктураМетода["ВозвращаемоеЗначение"]);
Макет = СтрЗаменить(Макет, "@Результат" , Результат); Макет = СтрЗаменить(Макет, "@Результат" , Результат);
Макет = СтрЗаменить(Макет, "@Примечание" , СтруктураМетода["Примечание"]);
ТаблицаПараметров = ""; ТаблицаПараметров = "";
Вызов1С = ПолучитьВызов1С(СтруктураМетода["ИмяМодуля"], СтруктураМетода["ИмяМетода"]); Вызов1С = ПолучитьВызов1С(СтруктураМетода["ИмяМодуля"], СтруктураМетода["ИмяМетода"]);
@ -361,7 +362,8 @@
СтруктураДанных.Вставить("ЕстьCLI", Истина); СтруктураДанных.Вставить("ЕстьCLI", Истина);
КонецЕсли; КонецЕсли;
МассивКомментария = СтрРазделить(ТекстКомментария, "//", Ложь); ТекстКомментария = СтрЗаменить(ТекстКомментария, "//", "$");
МассивКомментария = СтрРазделить(ТекстКомментария, "$", Ложь);
Если МассивКомментария.Количество() = 0 Тогда Если МассивКомментария.Количество() = 0 Тогда
Возврат Новый Массив; Возврат Новый Массив;
@ -375,9 +377,12 @@
Процедура СформироватьСтруктуруМетода(Знач МассивКомментария, МассивПараметров, СтруктураДанных) Процедура СформироватьСтруктуруМетода(Знач МассивКомментария, МассивПараметров, СтруктураДанных)
ОписаниеМетода = ""; ОписаниеМетода = "";
ЗаписыватьПараметры = Ложь; ЗаписыватьПараметры = Ложь;
ЗаписыватьОписание = Истина; ЗаписыватьПримечание = Ложь;
ЗаписыватьОписание = Истина;
ТекстПримечания = "";
Счетчик = 0; Счетчик = 0;
Для Каждого СтрокаКомментария Из МассивКомментария Цикл Для Каждого СтрокаКомментария Из МассивКомментария Цикл
@ -393,8 +398,14 @@
КонецЕсли; КонецЕсли;
Если СтрНайти(СтрокаКомментария, "Параметры:") > 0 Тогда Если СтрНайти(СтрокаКомментария, "Параметры:") > 0 Тогда
ЗаписыватьПараметры = Истина; ЗаписыватьПараметры = Истина;
ЗаписыватьОписание = Ложь; ЗаписыватьОписание = Ложь;
ЗаписыватьПримечание = Ложь;
ИначеЕсли СтрНайти(СтрокаКомментария, "Примечание:") > 0 Тогда
ЗаписыватьПараметры = Ложь;
ЗаписыватьОписание = Ложь;
ЗаписыватьПримечание = Истина;
ИначеЕсли СтрНайти(СтрокаКомментария, "Возвращаемое значение:") > 0 Тогда ИначеЕсли СтрНайти(СтрокаКомментария, "Возвращаемое значение:") > 0 Тогда
СтруктураДанных.Вставить("ВозвращаемоеЗначение", МассивКомментария[Счетчик]); СтруктураДанных.Вставить("ВозвращаемоеЗначение", МассивКомментария[Счетчик]);
@ -406,14 +417,33 @@
МассивПараметров.Добавить(СтрокаКомментария); МассивПараметров.Добавить(СтрокаКомментария);
ИначеЕсли ЗаписыватьПримечание = Истина Тогда
ТекстПримечания = ТекстПримечания + СтрокаКомментария + Символы.ПС;
Иначе Иначе
Продолжить; Продолжить;
КонецЕсли; КонецЕсли;
КонецЦикла; КонецЦикла;
СтруктураДанных.Вставить("Описание" , ОписаниеМетода); ТекстПримечания = СокрЛП(ТекстПримечания);
СтруктураДанных.Вставить("Заголовок", СтрЗаменить(СокрЛП(МассивКомментария[0]), "!NOCLI", ""));
Если ЗначениеЗаполнено(ТекстПримечания) Тогда
ТекстПримечания = СтрЗаменить(ТекстПримечания, "@", "https://");
ТекстПримечания = ":::tip"
+ Символы.ПС
+ ТекстПримечания
+ Символы.ПС
+ ":::";
КонецЕсли;
СтруктураДанных.Вставить("Описание" , ОписаниеМетода);
СтруктураДанных.Вставить("Заголовок" , СтрЗаменить(СокрЛП(МассивКомментария[0]), "!NOCLI", ""));
СтруктураДанных.Вставить("Примечание", ТекстПримечания);
КонецПроцедуры КонецПроцедуры
@ -492,6 +522,18 @@
КонецЕсли; КонецЕсли;
Если ЗначениеЗаполнено(Результат) Тогда
Результат = "```bsl title=""Пример кода"""
+ Символы.ПС
+ Результат
+ Символы.ПС
+ "```"
+ Символы.ПС;
КонецЕсли;
Возврат Результат; Возврат Результат;
КонецФункции КонецФункции
@ -636,6 +678,13 @@
Если ЗначениеЗаполнено(Результат) Тогда Если ЗначениеЗаполнено(Результат) Тогда
Результат = Лев(Результат, СтрДлина(Результат) - 1); Результат = Лев(Результат, СтрДлина(Результат) - 1);
Результат = "```json title=""Результат"""
+ Символы.ПС
+ Результат
+ Символы.ПС
+ "```";
КонецЕсли; КонецЕсли;
Возврат СокрЛП(Результат); Возврат СокрЛП(Результат);

View File

@ -6,6 +6,11 @@ sidebar_position: @Счетчик
@Описание @Описание
@Примечание
<br/>
*@Объявление* *@Объявление*
| Параметр | CLI опция | Тип | Назначение | | Параметр | CLI опция | Тип | Назначение |
@ -14,11 +19,9 @@ sidebar_position: @Счетчик
Возвращаемое значение: @ВозвращаемоеЗначение Возвращаемое значение: @ВозвращаемоеЗначение
```bsl title="Пример кода"
@Вызов1С
@Вызов1С
```
```sh title="Пример команды CLI" ```sh title="Пример команды CLI"
@ -26,9 +29,4 @@ sidebar_position: @Счетчик
``` ```
```json title="Результат"
@Результат @Результат
```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Creates a comment for a record in the table Creates a comment for a record in the table
<br/>
*Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export* *Function CreateComment(Val Token, Val Base, Val Table, Val Record, Val Text) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -19,8 +24,8 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -30,8 +35,9 @@ sidebar_position: 2
Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map Response = OPI_Airtable.CreateComment(Token, Base, Table, Record, Text); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"author": { "author": {
"id": "usrFlaAHlTfYWAbVW", "id": "usrFlaAHlTfYWAbVW",
@ -53,5 +57,4 @@ sidebar_position: 2
"createdTime": "2024-05-10T19:39:51.561Z", "createdTime": "2024-05-10T19:39:51.561Z",
"lastUpdatedTime": null "lastUpdatedTime": null
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 4
Deletes a comment for a table record Deletes a comment for a table record
<br/>
*Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export* *Function DeleteComment(Val Token, Val Base, Val Table, Val Record, Val Comment) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -19,8 +24,8 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -30,8 +35,9 @@ sidebar_position: 4
Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map Response = OPI_Airtable.DeleteComment(Token, Base, Table, Record, Comment); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,12 +45,9 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"deleted": true "deleted": true
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Changes the text of an existing comment Changes the text of an existing comment
<br/>
*Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export* *Function EditComment(Val Token, Val Base, Val Table, Val Record, Val Comment, Val Text) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -20,8 +25,8 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -32,8 +37,9 @@ sidebar_position: 3
Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map Response = OPI_Airtable.EditComment(Token, Base, Table, Record, Comment, Text); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -41,10 +47,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
"author": { "author": {
"id": "usrFlaAHlTfYWAbVW", "id": "usrFlaAHlTfYWAbVW",
@ -55,5 +59,4 @@ sidebar_position: 3
"createdTime": "2024-05-10T19:39:52Z", "createdTime": "2024-05-10T19:39:52Z",
"lastUpdatedTime": "2024-05-10T19:39:51.967Z" "lastUpdatedTime": "2024-05-10T19:39:51.967Z"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Gets the list of comments for a record in the table Gets the list of comments for a record in the table
<br/>
*Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export* *Function GetComments(Val Token, Val Base, Val Table, Val Record, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -19,8 +24,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -29,8 +34,9 @@ sidebar_position: 1
Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map Response = OPI_Airtable.GetComments(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -38,10 +44,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"comments": [ "comments": [
{ {
"id": "comL1oGEDJvIQlMs1", "id": "comL1oGEDJvIQlMs1",
@ -57,5 +61,4 @@ sidebar_position: 1
], ],
"offset": null "offset": null
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Creates one or an array of records by description or an array of field value descriptions Creates one or an array of records by description or an array of field value descriptions
<br/>
*Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export* *Function CreatePosts(Val Token, Val Base, Val Table, Val Data) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -36,8 +41,9 @@ sidebar_position: 3
Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map Response = OPI_Airtable.CreatePosts(Token, Base, Table, Data); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -45,10 +51,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"records": [ "records": [
{ {
"id": "recjHNKNZBWLZkZ7A", "id": "recjHNKNZBWLZkZ7A",
@ -68,5 +72,4 @@ sidebar_position: 3
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 4
Deletes one or an array of records by identifiers Deletes one or an array of records by identifiers
<br/>
*Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export* *Function DeletePosts(Val Token, Val Base, Val Table, Val Records) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -31,8 +36,9 @@ sidebar_position: 4
Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map Response = OPI_Airtable.DeletePosts(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -40,10 +46,8 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"records": [ "records": [
{ {
"deleted": true, "deleted": true,
@ -55,5 +59,4 @@ sidebar_position: 4
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Gets the list of records of the selected table Gets the list of records of the selected table
<br/>
*Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export* *Function GetListOfRecords(Val Token, Val Base, Val Table, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -27,8 +32,9 @@ sidebar_position: 1
Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map Response = OPI_Airtable.GetListOfRecords(Token, Base, Table, Indent); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -36,10 +42,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"records": [ "records": [
{ {
"id": "recGyJ0MlN1H3GMuN", "id": "recGyJ0MlN1H3GMuN",
@ -67,5 +71,4 @@ sidebar_position: 1
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Gets row data of the table by identifier Gets row data of the table by identifier
<br/>
*Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export* *Function GetRecord(Val Token, Val Base, Val Table, Val Record) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -28,8 +33,9 @@ sidebar_position: 2
Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map Response = OPI_Airtable.GetRecord(Token, Base, Table, Record); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -37,10 +43,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "recV6DxeLQMBNJrUk", "id": "recV6DxeLQMBNJrUk",
"createdTime": "2024-05-10T19:39:51Z", "createdTime": "2024-05-10T19:39:51Z",
"fields": { "fields": {
@ -48,5 +52,4 @@ sidebar_position: 2
"String": "Hello\n" "String": "Hello\n"
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Creates a new table in the base Creates a new table in the base
<br/>
*Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export* *Function CreateTable(Val Token, Val Base, Val Name, Val FieldArray, Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -19,8 +24,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
TableName = "TestTable2"; TableName = "TestTable2";
@ -39,8 +44,9 @@ sidebar_position: 1
Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map Response = OPI_Airtable.CreateTable(Token, Base, Name, FieldArray, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -48,10 +54,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "tblT64aWyrMUAbUmF", "id": "tblT64aWyrMUAbUmF",
"name": "TestTable2", "name": "TestTable2",
"description": "NewTable", "description": "NewTable",
@ -122,5 +126,4 @@ sidebar_position: 1
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Changes the name and/or description of the base Changes the name and/or description of the base
<br/>
*Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export* *Function ModifyTable(Val Token, Val Base, Val Table, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -19,8 +24,8 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -30,8 +35,9 @@ sidebar_position: 2
Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map Response = OPI_Airtable.ModifyTable(Token, Base, Table, Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "tblT64aWyrMUAbUmF", "id": "tblT64aWyrMUAbUmF",
"name": "Test table 2 (change.)", "name": "Test table 2 (change.)",
"description": "New table (change.)", "description": "New table (change.)",
@ -113,5 +117,4 @@ sidebar_position: 2
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Creates a new database Creates a new database
<br/>
*Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export* *Function CreateDatabase(Val Token, Val Workspace, Val Name, Val TableCollection) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Workspace = "wspdf8yl1yZz3PmWZ"; Workspace = "wspdf8yl1yZz3PmWZ";
Name = "TestDatabase"; Name = "TestDatabase";
@ -36,8 +41,9 @@ sidebar_position: 3
Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map Response = OPI_Airtable.CreateDatabase(Token, Workspace, Name, TableCollection); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -45,10 +51,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"id": "applEsyJmBRm12AuN", "id": "applEsyJmBRm12AuN",
"tables": [ "tables": [
{ {
@ -80,5 +84,4 @@ sidebar_position: 3
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Gets the schema of base tables Gets the schema of base tables
<br/>
*Function GetDatabaseTables(Val Token, Val Base) Export* *Function GetDatabaseTables(Val Token, Val Base) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,16 +21,17 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map Response = OPI_Airtable.GetDatabaseTables(Token, Base); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -33,10 +39,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"tables": [ "tables": [
{ {
"id": "tblqZzW78Rvsdt9gt", "id": "tblqZzW78Rvsdt9gt",
@ -67,5 +71,4 @@ sidebar_position: 2
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Gets the list of available bases Gets the list of available bases
<br/>
*Function GetListOfBases(Val Token, Val Indent = "") Export* *Function GetListOfBases(Val Token, Val Indent = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,15 +21,16 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Response = OPI_Airtable.GetListOfBases(Token); //Map Response = OPI_Airtable.GetListOfBases(Token); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,10 +38,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"bases": [ "bases": [
{ {
"id": "appGarzKZ0lu3gzoa", "id": "appGarzKZ0lu3gzoa",
@ -84,5 +88,4 @@ sidebar_position: 1
} }
] ]
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Creates a new field in the table Creates a new field in the table
<br/>
*Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export* *Function CreateField(Val Token, Val Base, Val Table, Val FieldStructure) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -29,8 +34,9 @@ sidebar_position: 1
Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map Response = OPI_Airtable.CreateField(Token, Base, Table, FieldStructure); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -38,10 +44,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
@ -49,5 +53,4 @@ sidebar_position: 1
"id": "fld3IbFtHZtBHQwsk", "id": "fld3IbFtHZtBHQwsk",
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5" "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 5
Gets the description of a file field Gets the description of a file field
<br/>
*Function GetAttachmentField(Val Name) Export* *Function GetAttachmentField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 5
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Attachment"; Name = "Attachment";
Response = OPI_Airtable.GetAttachmentField(Name); //Map Response = OPI_Airtable.GetAttachmentField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,12 +38,9 @@ sidebar_position: 5
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Attachment", "name": "Attachment",
"type": "multipleAttachments" "type": "multipleAttachments"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 6
Gets the description of a boolean field Gets the description of a boolean field
<br/>
*Function GetCheckboxField(Val Name) Export* *Function GetCheckboxField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 6
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Checkbox"; Name = "Checkbox";
Response = OPI_Airtable.GetCheckboxField(Name); //Map Response = OPI_Airtable.GetCheckboxField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,10 +38,8 @@ sidebar_position: 6
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Checkbox", "name": "Checkbox",
"type": "checkbox", "type": "checkbox",
"options": { "options": {
@ -43,5 +47,4 @@ sidebar_position: 6
"color": "yellowBright" "color": "yellowBright"
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 7
Gets the description of a date field Gets the description of a date field
<br/>
*Function GetDateField(Val Name) Export* *Function GetDateField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 7
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Date"; Name = "Date";
Response = OPI_Airtable.GetDateField(Name); //Map Response = OPI_Airtable.GetDateField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,10 +38,8 @@ sidebar_position: 7
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Date", "name": "Date",
"type": "date", "type": "date",
"options": { "options": {
@ -45,5 +49,4 @@ sidebar_position: 7
} }
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 8
Gets the description of an email field Gets the description of an email field
<br/>
*Function GetEmailField(Val Name) Export* *Function GetEmailField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 8
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Email"; Name = "Email";
Response = OPI_Airtable.GetEmailField(Name); //Map Response = OPI_Airtable.GetEmailField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,12 +38,9 @@ sidebar_position: 8
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Email", "name": "Email",
"type": "email" "type": "email"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 10
Gets the description of a URL field Gets the description of a URL field
<br/>
*Function GetLinkField(Val Name) Export* *Function GetLinkField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 10
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Link"; Name = "Link";
Response = OPI_Airtable.GetLinkField(Name); //Map Response = OPI_Airtable.GetLinkField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,12 +38,9 @@ sidebar_position: 10
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Link", "name": "Link",
"type": "url" "type": "url"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 4
Gets the description of a numeric field Gets the description of a numeric field
<br/>
*Function GetNumberField(Val Name, Val Precision = 0) Export* *Function GetNumberField(Val Name, Val Precision = 0) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,8 +21,8 @@ sidebar_position: 4
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Number"; Name = "Number";
Precision = "0"; Precision = "0";
@ -25,8 +30,9 @@ sidebar_position: 4
Response = OPI_Airtable.GetNumberField(Name, Precision); //Map Response = OPI_Airtable.GetNumberField(Name, Precision); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -34,15 +40,12 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Number", "name": "Number",
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 9
Gets the description of a phone number field Gets the description of a phone number field
<br/>
*Function GetPhoneField(Val Name) Export* *Function GetPhoneField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 9
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "Phone"; Name = "Phone";
Response = OPI_Airtable.GetPhoneField(Name); //Map Response = OPI_Airtable.GetPhoneField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,12 +38,9 @@ sidebar_position: 9
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "Phone", "name": "Phone",
"type": "phoneNumber" "type": "phoneNumber"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Gets the description of a string field Gets the description of a string field
<br/>
*Function GetStringField(Val Name) Export* *Function GetStringField(Val Name) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,16 +20,17 @@ sidebar_position: 3
Returns: Structure - Field description Returns: Structure - Field description
```bsl title="Code example" ```bsl title="Code example"
Name = "String"; Name = "String";
Response = OPI_Airtable.GetStringField(Name); //Map Response = OPI_Airtable.GetStringField(Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,12 +38,9 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"name": "String", "name": "String",
"type": "richText" "type": "richText"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Changes the name and/or description of an existing table field Changes the name and/or description of an existing table field
<br/>
*Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export* *Function ModifyField(Val Token, Val Base, Val Table, Val Field, Val Name = "", Val Description = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -20,8 +25,8 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON response from Airtable Returns: Map Of KeyAndValue - serialized JSON response from Airtable
```bsl title="Code example" ```bsl title="Code example"
Base = "apptm8Xqo7TwMaipQ"; Base = "apptm8Xqo7TwMaipQ";
Table = "tbl9G4jVoTJpxYwSY"; Table = "tbl9G4jVoTJpxYwSY";
@ -32,8 +37,9 @@ sidebar_position: 2
Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map Response = OPI_Airtable.ModifyField(Token, Base, Table, Field, Name, Description); //Map
Response = OPI_Tools.JSONString(Response); //JSON string Response = OPI_Tools.JSONString(Response); //JSON string
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -41,10 +47,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"type": "number", "type": "number",
"options": { "options": {
"precision": 0 "precision": 0
@ -53,5 +57,4 @@ sidebar_position: 2
"name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)", "name": "9c0d2a82-7bf9-40b7-8052-ae3ebadc72d5(change.)",
"description": "New description" "description": "New description"
} }
``` ```

View File

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

View File

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

View File

@ -0,0 +1,62 @@
---
sidebar_position: 8
---
# Delete result from comment
Deletes task result, created from a comment
<br/>
*Function DeleteResultFromComment(Val URL, Val CommentID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| CommentID | --comment | Number, String | CommentID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
CommentID = "1718";
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
CommentID = "1720";
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteResultFromComment --url "b24-ar17wx.bitrix24.by" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": null,
"time": {
"start": 1720295536.04613,
"finish": 1720295536.09868,
"duration": 0.0525519847869873,
"processing": 0.0231878757476807,
"date_start": "2024-07-06T19:52:16+00:00",
"date_finish": "2024-07-06T19:52:16+00:00",
"operating_reset_at": 1720296136,
"operating": 0
}
}
```

View File

@ -0,0 +1,64 @@
---
sidebar_position: 5
---
# Delete comment
Delete task comment by ID
<br/>
*Function DeleteTaskComment(Val URL, Val TaskID, Val CommentID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| CommentID | --comment | Number, String | ID of comment to remove |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "504";
CommentID = "1718";
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
CommentID = "1720";
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteTaskComment --url "b24-ar17wx.bitrix24.by" --task "504" --comment "1720" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720295541.27592,
"finish": 1720295541.38076,
"duration": 0.104840040206909,
"processing": 0.0781040191650391,
"date_start": "2024-07-06T19:52:21+00:00",
"date_finish": "2024-07-06T19:52:21+00:00",
"operating_reset_at": 1720296141,
"operating": 0
}
}
```

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 7
Adds new groups or users to the recipients Adds new groups or users to the recipients
<br/>
*Function AddPostRecipients(Val URL, Val PostID, Val Visibility, Val Token = "") Export* *Function AddPostRecipients(Val URL, Val PostID, Val Visibility, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 7
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
Visibility = "UA"; Visibility = "UA";
PostID = "124"; PostID = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
@ -31,8 +36,9 @@ sidebar_position: 7
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility, Token); Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -40,10 +46,8 @@ sidebar_position: 7
``` ```
```json title="Result" ```json title="Result"
{
{
"result": true, "result": true,
"time": { "time": {
"start": 1718473318.17435, "start": 1718473318.17435,
@ -56,5 +60,4 @@ sidebar_position: 7
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,13 @@ sidebar_position: 1
Create a new post at news feed Create a new post at news feed
:::tip
API method: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_help/log/log_blogpost_add.php)
:::
<br/>
*Function CreatePost(Val URL, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Important = False, Val Token = "") Export* *Function CreatePost(Val URL, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Important = False, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -21,8 +28,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
Text = "Text of post"; Text = "Text of post";
Title = "Post title"; Title = "Post title";
Image1 = "https://openintegrations.dev/test_data/picture.jpg"; Image1 = "https://openintegrations.dev/test_data/picture.jpg";
@ -42,8 +49,9 @@ sidebar_position: 1
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreatePost(URL, Text,, Files, Title,, Token); Result = OPI_Bitrix24.CreatePost(URL, Text,, Files, Title,, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -51,10 +59,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"result": 18, "result": 18,
"time": { "time": {
"start": 1718130364.82176, "start": 1718130364.82176,
@ -67,5 +73,4 @@ sidebar_position: 1
"operating": 0.637988090515137 "operating": 0.637988090515137
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Remove post from a news feed Remove post from a news feed
<br/>
*Function DeletePost(Val URL, Val PostID, Val Token = "") Export* *Function DeletePost(Val URL, Val PostID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
PostID = "122"; PostID = "122";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
@ -30,8 +35,9 @@ sidebar_position: 3
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.DeletePost(URL, PostID, Token); Result = OPI_Bitrix24.DeletePost(URL, PostID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"result": true, "result": true,
"time": { "time": {
"start": 1718130367.40777, "start": 1718130367.40777,
@ -55,5 +59,4 @@ sidebar_position: 3
"operating": 0.310499906539917 "operating": 0.310499906539917
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 4
Return list of important post viewers ids Return list of important post viewers ids
<br/>
*Function GetImportantPostViewers(Val URL, Val PostID, Val Token = "") Export* *Function GetImportantPostViewers(Val URL, Val PostID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
PostID = "122"; PostID = "122";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
@ -29,8 +34,9 @@ sidebar_position: 4
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID, Token); Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -38,10 +44,8 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"result": [ "result": [
"1" "1"
], ],
@ -56,5 +60,4 @@ sidebar_position: 4
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 5
Gen post or array of post with ID or rights selection Gen post or array of post with ID or rights selection
<br/>
*Function GetPosts(Val URL, Val PostID = "", Val Filter = "UA", Val Token = "") Export* *Function GetPosts(Val URL, Val PostID = "", Val Filter = "UA", Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 5
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
PostID = "124"; PostID = "124";
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
@ -30,8 +35,9 @@ sidebar_position: 5
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetPosts(URL, PostID,, Token); Result = OPI_Bitrix24.GetPosts(URL, PostID,, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 5
``` ```
```json title="Result" ```json title="Result"
{
{
"result": [ "result": [
{ {
"ID": "40", "ID": "40",
@ -410,5 +414,4 @@ sidebar_position: 5
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Change post data Change post data
<br/>
*Function UpdatePost(Val URL, Val PostID, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Token = "") Export* *Function UpdatePost(Val URL, Val PostID, Val Text, Val Visibility = "UA", Val Files = "", Val Title = "", Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -21,8 +26,8 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
Text = "New post text"; Text = "New post text";
Title = "New post title"; Title = "New post title";
Image1 = "https://openintegrations.dev/test_data/picture.jpg"; Image1 = "https://openintegrations.dev/test_data/picture.jpg";
@ -41,8 +46,9 @@ sidebar_position: 2
PostID = "122"; PostID = "122";
Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text,, Files, Title, Token); Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text,, Files, Title, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -50,10 +56,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"result": 86, "result": 86,
"time": { "time": {
"start": 1718473311.53949, "start": 1718473311.53949,
@ -66,5 +70,4 @@ sidebar_position: 2
"operating": 0.326629877090454 "operating": 0.326629877090454
} }
} }
``` ```

View File

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

View File

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

View File

@ -0,0 +1,554 @@
---
sidebar_position: 3
---
# Get kanban stages
Get kanban (My Plan) stages info
<br/>
*Function GetKanbanStages(Val URL, Val EntityID = 0, Val AsAdmin = False, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| EntityID | --entityid | String, Number | ID of kanban owner (group or user) |
| AsAdmin | --admin | Boolean | Allows you to get stages without checking permissions (for administrators) |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetKanbanStages(URL,, True);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetKanbanStages(URL,,, Token);
```
```sh title="CLI command example"
oint bitrix24 GetKanbanStages --url "b24-ar17wx.bitrix24.by" --entityid %entityid% --admin %admin% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"20": {
"ID": "20",
"TITLE": "New stage",
"SORT": "100",
"COLOR": "0026FF",
"SYSTEM_TYPE": "NEW",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"24": {
"ID": "24",
"TITLE": "Name",
"SORT": "200",
"COLOR": "75d900",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"16": {
"ID": "16",
"TITLE": "New stage",
"SORT": "300",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"18": {
"ID": "18",
"TITLE": "New stage 2",
"SORT": "400",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"12": {
"ID": "12",
"TITLE": "New stage",
"SORT": "500",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"14": {
"ID": "14",
"TITLE": "New stage 2",
"SORT": "600",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"8": {
"ID": "8",
"TITLE": "New stage",
"SORT": "700",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"10": {
"ID": "10",
"TITLE": "New stage 2",
"SORT": "800",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"6": {
"ID": "6",
"TITLE": "New stage",
"SORT": "900",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"130": {
"ID": "130",
"TITLE": "New stage",
"SORT": "1000",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"132": {
"ID": "132",
"TITLE": "New stage 2",
"SORT": "1100",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"122": {
"ID": "122",
"TITLE": "New stage",
"SORT": "1200",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"124": {
"ID": "124",
"TITLE": "New stage 2",
"SORT": "1300",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"120": {
"ID": "120",
"TITLE": "New stage 2",
"SORT": "1400",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"114": {
"ID": "114",
"TITLE": "New stage",
"SORT": "1500",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"116": {
"ID": "116",
"TITLE": "New stage 2",
"SORT": "1600",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"112": {
"ID": "112",
"TITLE": "New stage 2",
"SORT": "1700",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"108": {
"ID": "108",
"TITLE": "New stage 2",
"SORT": "1800",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"104": {
"ID": "104",
"TITLE": "New stage 2",
"SORT": "1900",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"100": {
"ID": "100",
"TITLE": "New stage 2",
"SORT": "2000",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"96": {
"ID": "96",
"TITLE": "New stage 2",
"SORT": "2100",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"90": {
"ID": "90",
"TITLE": "New stage",
"SORT": "2200",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"92": {
"ID": "92",
"TITLE": "New stage 2",
"SORT": "2300",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"74": {
"ID": "74",
"TITLE": "New stage",
"SORT": "2400",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"76": {
"ID": "76",
"TITLE": "New stage 2",
"SORT": "2500",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"70": {
"ID": "70",
"TITLE": "New stage",
"SORT": "2600",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"72": {
"ID": "72",
"TITLE": "New stage 2",
"SORT": "2700",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"66": {
"ID": "66",
"TITLE": "New stage",
"SORT": "2800",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"68": {
"ID": "68",
"TITLE": "New stage 2",
"SORT": "2900",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"62": {
"ID": "62",
"TITLE": "New stage",
"SORT": "3000",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"64": {
"ID": "64",
"TITLE": "New stage 2",
"SORT": "3100",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"46": {
"ID": "46",
"TITLE": "New stage",
"SORT": "3200",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"48": {
"ID": "48",
"TITLE": "New stage 2",
"SORT": "3300",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"42": {
"ID": "42",
"TITLE": "New stage",
"SORT": "3400",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"44": {
"ID": "44",
"TITLE": "New stage 2",
"SORT": "3500",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"38": {
"ID": "38",
"TITLE": "New stage",
"SORT": "3600",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"40": {
"ID": "40",
"TITLE": "New stage 2",
"SORT": "3700",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"34": {
"ID": "34",
"TITLE": "New stage",
"SORT": "3800",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"36": {
"ID": "36",
"TITLE": "New stage 2",
"SORT": "3900",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"2": {
"ID": "2",
"TITLE": "Not withplanandроinаны",
"SORT": "4000",
"COLOR": "00C4FB",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"4": {
"ID": "4",
"TITLE": "Сделаю to notделе",
"SORT": "4100",
"COLOR": "47D1E2",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
}
},
"time": {
"start": 1720600362.36054,
"finish": 1720600362.39851,
"duration": 0.0379610061645508,
"processing": 0.00239396095275879,
"date_start": "2024-07-10T08:32:42+00:00",
"date_finish": "2024-07-10T08:32:42+00:00",
"operating_reset_at": 1720600962,
"operating": 0
}
}
```

View File

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

View File

@ -0,0 +1,4 @@
{
"label": "Kanban",
"position": "6"
}

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Forms a link for authorization via the browser Forms a link for authorization via the browser
<br/>
*Function GetAppAuthLink(Val Domain, Val ClientID) Export* *Function GetAppAuthLink(Val Domain, Val ClientID) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,11 +21,15 @@ sidebar_position: 1
Returns: String - URL for browser transition Returns: String - URL for browser transition
```bsl title="Code example" ```bsl title="Code example"
Domain = "b24-ar17wx.bitrix24.by";
ClientID = "local.6667fc928a50a9.70414732";
Result = OPI_Bitrix24.GetAppAuthLink(Domain, ClientID);
```
```
```sh title="CLI command example" ```sh title="CLI command example"
@ -28,9 +37,6 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732"
"https://b24-ar17wx.bitrix24.by/oauth/authorize/?client_id=local.6667fc928a50a9.70414732"
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Get token by auth code Get token by auth code
<br/>
*Function GetToken(Val ClientID, Val ClientSecret, Val Code) Export* *Function GetToken(Val ClientID, Val ClientSecret, Val Code) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,15 +22,16 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
ClientID = "local.6667fc928a50a9.70414732"; ClientID = "local.6667fc928a50a9.70414732";
ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V...";
Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c"; Code = "2b096866006e9f06006b12e400000001000007fc1bc681f7ed7f13f2d449980628008c";
Result = OPI_Bitrix24.GetToken(ClientID, ClientSecret, Code); Result = OPI_Bitrix24.GetToken(ClientID, ClientSecret, Code);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -33,12 +39,9 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"error": "expired_token", "error": "expired_token",
"error_description": "The authorization token provided has expired." "error_description": "The authorization token provided has expired."
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Update token by refresh token Update token by refresh token
<br/>
*Function RefreshToken(Val ClientID, Val ClientSecret, Val Refresh) Export* *Function RefreshToken(Val ClientID, Val ClientSecret, Val Refresh) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,15 +22,16 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
ClientID = "local.6667fc928a50a9.70414732"; ClientID = "local.6667fc928a50a9.70414732";
ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V..."; ClientSecret = "ZeKyeYIgy2NsHZqsIHY6GfG1V...";
Refresh = "a95e9b66006e9f06006b12e400000001000..."; Refresh = "a95e9b66006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.RefreshToken(ClientID, ClientSecret, Refresh); Result = OPI_Bitrix24.RefreshToken(ClientID, ClientSecret, Refresh);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -33,10 +39,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"access_token": "63a46866006e9f06006b12e4000000010000071997e1f54c1043e9f7193734af3018df", "access_token": "63a46866006e9f06006b12e4000000010000071997e1f54c1043e9f7193734af3018df",
"expires": 1718133859, "expires": 1718133859,
"expires_in": 3600, "expires_in": 3600,
@ -49,5 +53,4 @@ sidebar_position: 3
"user_id": 1, "user_id": 1,
"refresh_token": "53239066006e9f06006b12e4000000010000078523b1fc75d58d6f0fa98b4632bc70ce" "refresh_token": "53239066006e9f06006b12e4000000010000078523b1fc75d58d6f0fa98b4632bc70ce"
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 4
Get current server time Get current server time
<br/>
*Function ServerTime(Val URL, Val Token = "") Export* *Function ServerTime(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,8 +21,8 @@ sidebar_position: 4
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.ServerTime(URL); Result = OPI_Bitrix24.ServerTime(URL);
@ -27,8 +32,9 @@ sidebar_position: 4
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.ServerTime(URL, Token); Result = OPI_Bitrix24.ServerTime(URL, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -36,10 +42,8 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"result": "2024-06-13T18:40:54+00:00", "result": "2024-06-13T18:40:54+00:00",
"time": { "time": {
"start": 1718304054.57877, "start": 1718304054.57877,
@ -52,5 +56,4 @@ sidebar_position: 4
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 7
Create new foldera at the storage Create new foldera at the storage
<br/>
*Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export* *Function CreateStorageFolder(Val URL, Val StorageID, Val Name, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 7
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
StorageID = 3; StorageID = 3;
Name = "New catalog"; Name = "New catalog";
Filename2 = "New folder 2"; Filename2 = "New folder 2";
@ -34,8 +39,9 @@ sidebar_position: 7
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token); Result = OPI_Bitrix24.CreateStorageFolder(URL, StorageID, Name, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -43,10 +49,8 @@ sidebar_position: 7
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"ID": 574, "ID": 574,
"NAME": "New catalog", "NAME": "New catalog",
@ -75,5 +79,4 @@ sidebar_position: 7
"operating": 0 "operating": 0
} }
} }
``` ```

View File

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

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 8 sidebar_position: 12
--- ---
# Delete file # Delete file
Delete file by ID Delete file by ID
<br/>
*Function DeleteFile(Val URL, Val FileID, Val Token = "") Export* *Function DeleteFile(Val URL, Val FileID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 8
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FileID = "488"; FileID = "488";
@ -30,8 +35,9 @@ sidebar_position: 8
FileID = "478"; FileID = "478";
Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token); Result = OPI_Bitrix24.DeleteFile(URL, FileID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 8
``` ```
```json title="Result" ```json title="Result"
{
{
"result": true, "result": true,
"time": { "time": {
"start": 1718783933.86753, "start": 1718783933.86753,
@ -55,5 +59,4 @@ sidebar_position: 8
"operating": 3.73615193367004 "operating": 3.73615193367004
} }
} }
``` ```

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 9 sidebar_position: 13
--- ---
# Delete folder # Delete folder
Remove folder with subfolders Remove folder with subfolders
<br/>
*Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export* *Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 9
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FolderID = "480"; FolderID = "480";
@ -30,8 +35,9 @@ sidebar_position: 9
FolderID = "482"; FolderID = "482";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token); Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 9
``` ```
```json title="Result" ```json title="Result"
{
{
"result": true, "result": true,
"time": { "time": {
"start": 1719047257.50616, "start": 1719047257.50616,
@ -55,5 +59,4 @@ sidebar_position: 9
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 2
Get information about storage with which the application can work to store its data Get information about storage with which the application can work to store its data
<br/>
*Function GetAppSotrage(Val URL, Val Token = "") Export* *Function GetAppSotrage(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,14 +21,15 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "b24-ar17wx.bitrix24.by"; URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetAppSotrage(URL, Token); Result = OPI_Bitrix24.GetAppSotrage(URL, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -32,8 +38,3 @@ sidebar_position: 2
``` ```
```json title="Result"
```

View File

@ -0,0 +1,61 @@
---
sidebar_position: 21
---
# Get external link for a file
Get external link to file
<br/>
*Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FileID = "2484";
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFileExternalLink --url "b24-ar17wx.bitrix24.by" --fileid "2484" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "https://b24-ar17wx.bitrix24.by/~pT3DD",
"time": {
"start": 1720017752.7023,
"finish": 1720017752.74417,
"duration": 0.0418639183044434,
"processing": 0.00636386871337891,
"date_start": "2024-07-03T14:42:32+00:00",
"date_finish": "2024-07-03T14:42:32+00:00",
"operating_reset_at": 1720018352,
"operating": 0
}
}
```

View File

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

View File

@ -0,0 +1,61 @@
---
sidebar_position: 14
---
# Get external link for folder
Get external link to folder
<br/>
*Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FolderID = "2490";
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderExternalLink --url "b24-ar17wx.bitrix24.by" --folderid "2490" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": "https://b24-ar17wx.bitrix24.by/~hWalI",
"time": {
"start": 1719472796.12325,
"finish": 1719472796.16843,
"duration": 0.0451798439025879,
"processing": 0.0110611915588379,
"date_start": "2024-06-27T07:19:56+00:00",
"date_finish": "2024-06-27T07:19:56+00:00",
"operating_reset_at": 1719473396,
"operating": 0
}
}
```

View File

@ -0,0 +1,59 @@
---
sidebar_position: 27
---
# Get fields structure for folder items filter
Returns filter structure for child folder items
<br/>
*Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Structure of Key-Value - Fields structure
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetFolderFilterStructure(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetFolderFilterStructure(URL, True, Token);
```
```sh title="CLI command example"
oint bitrix24 GetFolderFilterStructure --url "b24-ar17wx.bitrix24.by" --empty %empty% --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"ID": "",
"NAME": "",
"TYPE": "",
"CODE": "",
"STORAGE_ID": "",
"PARENT_ID": "",
"CREATE_TIME": "",
"UPDATE_TIME": "",
"DELETE_TIME": "",
"DELETED_TYPE": ""
}
```

View File

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

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 5
Get a list of files and folders, located at the root of the storage Get a list of files and folders, located at the root of the storage
<br/>
*Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export* *Function GetStorageObjects(Val URL, Val StorageID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 5
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
StorageID = 3; StorageID = 3;
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID); Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID);
@ -28,8 +33,9 @@ sidebar_position: 5
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token); Result = OPI_Bitrix24.GetStorageObjects(URL, StorageID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -37,10 +43,8 @@ sidebar_position: 5
``` ```
```json title="Result" ```json title="Result"
{
{
"result": [ "result": [
{ {
"ID": "568", "ID": "568",
@ -95,5 +99,4 @@ sidebar_position: 5
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 3
Get information about storage Get information about storage
<br/>
*Function GetStorage(Val URL, Val StorageID, Val Token = "") Export* *Function GetStorage(Val URL, Val StorageID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
StorageID = 3; StorageID = 3;
@ -29,8 +34,9 @@ sidebar_position: 3
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token); Result = OPI_Bitrix24.GetStorage(URL, StorageID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -38,10 +44,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"ID": "3", "ID": "3",
"NAME": "Main drive", "NAME": "Main drive",
@ -62,5 +66,4 @@ sidebar_position: 3
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 1
Get list of available files storages Get list of available files storages
<br/>
*Function GetStoragesList(Val URL, Val Token = "") Export* *Function GetStoragesList(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,8 +21,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetStoragesList(URL); Result = OPI_Bitrix24.GetStoragesList(URL);
@ -26,8 +31,9 @@ sidebar_position: 1
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetStoragesList(URL, Token); Result = OPI_Bitrix24.GetStoragesList(URL, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -35,10 +41,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"result": [ "result": [
{ {
"ID": "3", "ID": "3",
@ -116,5 +120,4 @@ sidebar_position: 1
"operating": 0 "operating": 0
} }
} }
``` ```

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 4
Change storage name (for app storage only, see. GetAppStorage) Change storage name (for app storage only, see. GetAppStorage)
<br/>
*Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export* *Function RenameStorage(Val URL, Val StorageID, Val Name, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,16 +23,17 @@ sidebar_position: 4
Returns: HTTPResponse - Rename storage Returns: HTTPResponse - Rename storage
```bsl title="Code example" ```bsl title="Code example"
Name = "New storage name"; Name = "New storage name";
URL = "b24-ar17wx.bitrix24.by"; URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
StorageID = "18"; StorageID = "18";
Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token); Result = OPI_Bitrix24.RenameStorage(URL, StorageID, Name, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -35,10 +41,8 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"ID": "18", "ID": "18",
"NAME": "New storage name", "NAME": "New storage name",
@ -59,5 +63,4 @@ sidebar_position: 4
"operating": 0 "operating": 0
} }
} }
``` ```

View File

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

View File

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

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 6
Upload file to storage root Upload file to storage root
<br/>
*Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export* *Function UploadFileToStorage(Val URL, Val Name, Val File, Val StorageID, Val Rights = "", Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -20,8 +25,8 @@ sidebar_position: 6
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
Filename2 = "Picture2.jpg"; Filename2 = "Picture2.jpg";
Name = "Picture1.jpg"; Name = "Picture1.jpg";
@ -40,8 +45,9 @@ sidebar_position: 6
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token); Result = OPI_Bitrix24.UploadFileToStorage(URL, Name, Image, DestinationID,, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -49,10 +55,8 @@ sidebar_position: 6
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"ID": 356, "ID": 356,
"NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg", "NAME": "26417397-8431-4343-9c0f-a40d4a2831c8.jpg",
@ -84,5 +88,4 @@ sidebar_position: 6
"operating": 0.227726936340332 "operating": 0.227726936340332
} }
} }
``` ```

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 17
Add task to favorites list Add task to favorites list
<br/>
*Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export* *Function AddTaskToFavorites(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 17
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 17
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token); Result = OPI_Bitrix24.AddTaskToFavorites(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 17
``` ```
```json title="Result" ```json title="Result"
{
{
"result": true, "result": true,
"time": { "time": {
"start": 1718569733.98858, "start": 1718569733.98858,
@ -55,5 +59,4 @@ sidebar_position: 17
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 7
Approve task by ID Approve task by ID
<br/>
*Function ApproveTask(Val URL, Val TaskID, Val Token = "") Export* *Function ApproveTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 7
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 7
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.ApproveTask(URL, TaskID, Token); Result = OPI_Bitrix24.ApproveTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 7
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "110", "id": "110",
@ -213,5 +217,4 @@ sidebar_position: 7
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -0,0 +1,66 @@
---
sidebar_position: 6
---
# Attach file to the topic
Attaches a file to the selected task
<br/>
*Function AttachFileToTopic(Val URL, Val TaskID, Val FileID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| TaskID | --task | Number, String | Task ID |
| FileID | --fileid | Number, String | File ID |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "500";
FileID = "2480";
Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "56898d66006e9f06006b12e400000001000...";
TaskID = "502";
Result = OPI_Bitrix24.AttachFileToTopic(URL, TaskID, FileID, Token);
```
```sh title="CLI command example"
oint bitrix24 AttachFileToTopic --url "b24-ar17wx.bitrix24.by" --task "502" --fileid "2480" --token "56898d66006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": {
"attachmentId": 598
},
"time": {
"start": 1720017736.90778,
"finish": 1720017736.97555,
"duration": 0.0677700042724609,
"processing": 0.0367820262908936,
"date_start": "2024-07-03T14:42:16+00:00",
"date_finish": "2024-07-03T14:42:16+00:00",
"operating_reset_at": 1720018336,
"operating": 0
}
}
```

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 9
Complete task by ID Complete task by ID
<br/>
*Function CompleteTask(Val URL, Val TaskID, Val Token = "") Export* *Function CompleteTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 9
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 9
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.CompleteTask(URL, TaskID, Token); Result = OPI_Bitrix24.CompleteTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 9
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "110", "id": "110",
@ -185,5 +189,4 @@ sidebar_position: 9
"operating": 0.312941789627075 "operating": 0.312941789627075
} }
} }
``` ```

View File

@ -1,24 +1,29 @@
--- ---
sidebar_position: 4 sidebar_position: 3
--- ---
# Create task # Create task
Create new task by fields structure (see GetTaskFieldsStructure) Create new task by fields structure (see GetTaskFieldsStructure)
<br/>
*Function CreateTask(Val URL, Val FieldsStructure, Val Token = "") Export* *Function CreateTask(Val URL, Val FieldsStructure, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
|-|-|-|-| |-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used | | URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FieldsStructure | --fields | Structure of Key-Value | Task fields structure | | FieldsStructure | --fields | Structure of Key-Value | Task fields structure (see GetTaskFieldsStructure) |
| Token | --token | String | Access token, when not-webhook method used | | Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
// The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function() // The complete structure of the fields can be obtained by the GetTaskFieldsStructure() function()
CurrentDate = OPI_Tools.GetCurrentDate(); CurrentDate = OPI_Tools.GetCurrentDate();
@ -43,8 +48,9 @@ sidebar_position: 4
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.CreateTask(URL, TaskData, Token); Result = OPI_Bitrix24.CreateTask(URL, TaskData, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -52,10 +58,8 @@ sidebar_position: 4
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "110", "id": "110",
@ -198,5 +202,4 @@ sidebar_position: 4
"operating": 0 "operating": 0
} }
} }
``` ```

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 11
Defer task by ID Defer task by ID
<br/>
*Function DeferTask(Val URL, Val TaskID, Val Token = "") Export* *Function DeferTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 11
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 11
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.DeferTask(URL, TaskID, Token); Result = OPI_Bitrix24.DeferTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 11
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "110", "id": "110",
@ -185,5 +189,4 @@ sidebar_position: 11
"operating": 0.131969928741455 "operating": 0.131969928741455
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 16
Delegate task to another user Delegate task to another user
<br/>
*Function DelegateTask(Val URL, Val TaskID, Val UserID, Val Token = "") Export* *Function DelegateTask(Val URL, Val TaskID, Val UserID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 16
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
UserID = "10"; UserID = "10";
@ -32,8 +37,9 @@ sidebar_position: 16
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID, Token); Result = OPI_Bitrix24.DelegateTask(URL, TaskID, UserID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -41,10 +47,8 @@ sidebar_position: 16
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "154", "id": "154",
@ -197,5 +201,4 @@ sidebar_position: 16
"operating": 0.450687170028686 "operating": 0.450687170028686
} }
} }
``` ```

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 6 sidebar_position: 5
--- ---
# Delete task # Delete task
Delete task by ID Delete task by ID
<br/>
*Function DeleteTask(Val URL, Val TaskID, Val Token = "") Export* *Function DeleteTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 6
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 6
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.DeleteTask(URL, TaskID, Token); Result = OPI_Bitrix24.DeleteTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 6
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": true "task": true
}, },
@ -57,5 +61,4 @@ sidebar_position: 6
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -0,0 +1,37 @@
---
sidebar_position: 24
---
# Delete tasks dependencies
Removes the dependency of one task to another
<br/>
*Function DeleteTasksDependencies(Val URL, Val FromID, Val DestinationID, Val LinkType, Val Token = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FromID | --taskfrom | String, Number | From task ID |
| DestinationID | --taskto | String, Number | To task ID |
| LinkType | --linktype | String, Number | Link type: 0 start>start, 1 start>finish, 2 finish>start, 3 finish>finish |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```sh title="CLI command example"
oint bitrix24 DeleteTasksDependencies --url %url% --taskfrom %taskfrom% --taskto %taskto% --linktype %linktype% --token %token%
```

View File

@ -6,6 +6,11 @@ sidebar_position: 8
Disapprove task by ID Disapprove task by ID
<br/>
*Function DisapproveTask(Val URL, Val TaskID, Val Token = "") Export* *Function DisapproveTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 8
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 8
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.DisapproveTask(URL, TaskID, Token); Result = OPI_Bitrix24.DisapproveTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,12 +45,9 @@ sidebar_position: 8
``` ```
```json title="Result" ```json title="Result"
{
{
"error": 1048582, "error": 1048582,
"error_description": "Action on the task is not allowed" "error_description": "Action on the task is not allowed"
} }
``` ```

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 1 sidebar_position: 25
--- ---
# Get task fields structure # Get task fields structure
Gets a structure with a description of the fields for creating a task Gets a structure with a description of the fields for creating a task
<br/>
*Function GetTaskFieldsStructure(Val URL, Val Token = "") Export* *Function GetTaskFieldsStructure(Val URL, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -16,8 +21,8 @@ sidebar_position: 1
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetTaskFieldsStructure(URL); Result = OPI_Bitrix24.GetTaskFieldsStructure(URL);
@ -27,8 +32,9 @@ sidebar_position: 1
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token); Result = OPI_Bitrix24.GetTaskFieldsStructure(URL, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -36,10 +42,8 @@ sidebar_position: 1
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"fields": { "fields": {
"ID": { "ID": {
@ -420,5 +424,4 @@ sidebar_position: 1
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 19
Get history of task changing Get history of task changing
<br/>
*Function GetTaskHistory(Val URL, Val TaskID, Val Token = "") Export* *Function GetTaskHistory(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 19
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 19
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID, Token); Result = OPI_Bitrix24.GetTaskHistory(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 19
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"list": [ "list": [
{ {
@ -298,5 +302,4 @@ sidebar_position: 19
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 2 sidebar_position: 1
--- ---
# Get task # Get task
Get task by ID Get task by ID
<br/>
*Function GetTask(Val URL, Val TaskID, Val Token = "") Export* *Function GetTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 2
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 2
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.GetTask(URL, TaskID, Token); Result = OPI_Bitrix24.GetTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 2
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "110", "id": "110",
@ -185,5 +189,4 @@ sidebar_position: 2
"operating": 0 "operating": 0
} }
} }
``` ```

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 21 sidebar_position: 26
--- ---
# Get structure of tasks filter # Get structure of tasks filter
Return filter structure for GetTasksList Return filter structure for GetTasksList
<br/>
*Function GetTasksFilterStructure(Val Clear = False) Export* *Function GetTasksFilterStructure(Val Clear = False) Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -15,11 +20,9 @@ sidebar_position: 21
Returns: Structure of Key-Value - Fields structure Returns: Structure of Key-Value - Fields structure
```bsl title="Code example"
```
```sh title="CLI command example" ```sh title="CLI command example"
@ -28,8 +31,3 @@ sidebar_position: 21
``` ```
```json title="Result"
```

View File

@ -1,11 +1,16 @@
--- ---
sidebar_position: 3 sidebar_position: 2
--- ---
# Get tasks list # Get tasks list
Get tasks list (50 at one response max)) Get tasks list (50 at one response max))
<br/>
*Function GetTasksList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export* *Function GetTasksList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -18,8 +23,8 @@ sidebar_position: 3
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
// Full filter structer you can find at GetTasksFilterStructure method // Full filter structer you can find at GetTasksFilterStructure method
Filter = New Structure; Filter = New Structure;
Filter.Insert("CREATED_BY", 1); Filter.Insert("CREATED_BY", 1);
@ -35,8 +40,9 @@ sidebar_position: 3
Token = "b9df7366006e9f06006b12e400000001000..."; Token = "b9df7366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetTasksList(URL,, Indent, Token); Result = OPI_Bitrix24.GetTasksList(URL,, Indent, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -44,10 +50,8 @@ sidebar_position: 3
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"tasks": [ "tasks": [
{ {
@ -4015,5 +4019,4 @@ sidebar_position: 3
"operating": 0 "operating": 0
} }
} }
``` ```

View File

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

View File

@ -6,6 +6,11 @@ sidebar_position: 12
Pause a task by ID Pause a task by ID
<br/>
*Function PauseTask(Val URL, Val TaskID, Val Token = "") Export* *Function PauseTask(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 12
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 12
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.PauseTask(URL, TaskID, Token); Result = OPI_Bitrix24.PauseTask(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 12
``` ```
```json title="Result" ```json title="Result"
{
{
"result": { "result": {
"task": { "task": {
"id": "110", "id": "110",
@ -185,5 +189,4 @@ sidebar_position: 12
"operating": 0.149271011352539 "operating": 0.149271011352539
} }
} }
``` ```

View File

@ -6,6 +6,11 @@ sidebar_position: 18
Delete task from favorites list Delete task from favorites list
<br/>
*Function RemoveTaskFromFavorites(Val URL, Val TaskID, Val Token = "") Export* *Function RemoveTaskFromFavorites(Val URL, Val TaskID, Val Token = "") Export*
| Parameter | CLI option | Type | Destination | | Parameter | CLI option | Type | Destination |
@ -17,8 +22,8 @@ sidebar_position: 18
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
```bsl title="Code example" ```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/"; URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
TaskID = "168"; TaskID = "168";
@ -30,8 +35,9 @@ sidebar_position: 18
TaskID = "170"; TaskID = "170";
Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID, Token); Result = OPI_Bitrix24.RemoveTaskFromFavorites(URL, TaskID, Token);
``` ```
```sh title="CLI command example" ```sh title="CLI command example"
@ -39,10 +45,8 @@ sidebar_position: 18
``` ```
```json title="Result" ```json title="Result"
{
{
"result": true, "result": true,
"time": { "time": {
"start": 1718569735.08926, "start": 1718569735.08926,
@ -55,5 +59,4 @@ sidebar_position: 18
"operating": 0 "operating": 0
} }
} }
``` ```

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