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

Правка доков

This commit is contained in:
Anton 2024-07-30 22:56:09 +03:00
parent 3d9d1a0a5d
commit bccd4a2dbc
463 changed files with 1379 additions and 3172 deletions

View File

@ -38,6 +38,7 @@ Method at API documentation: [disk.folder.addsubfolder](https://dev.1c-bitrix.ru
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.folder.deletetree](https://dev.1c-bitrix.ru/r
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
FolderID = "3278";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.folder.getExternalLink](https://dev.1c-bitrix
Result = OPI_Bitrix24.GetFolderExternalLink(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -32,6 +32,7 @@ Method at API documentation: [disk.folder.getfields](https://dev.1c-bitrix.ru/re
Result = OPI_Bitrix24.GetFolderFilterStructure(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.folder.get](https://dev.1c-bitrix.ru/rest_hel
Result = OPI_Bitrix24.GetFolderInformation(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -34,6 +34,7 @@ Method at API documentation: [disk.folder.getchildren](https://dev.1c-bitrix.ru/
Result = OPI_Bitrix24.GetFolderItems(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -36,6 +36,7 @@ Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID);
DestinationID = "3282";
FolderID = "3280";
@ -44,6 +45,7 @@ Method at API documentation: [disk.folder.copyto](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.MakeFolderCopy(URL, FolderID, DestinationID, Token);
Check_BitrixObject(Result);
```

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.folder.markdeleted](https://dev.1c-bitrix.ru/
Result = OPI_Bitrix24.MarkFolderAsDeleted(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -36,6 +36,7 @@ Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID);
FolderID = "3280";
URL = "b24-ar17wx.bitrix24.by";
@ -43,6 +44,7 @@ Method at API documentation: [disk.folder.moveto](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.MoveFolder(URL, FolderID, DestinationID, Token);
Check_BitrixObject(Result);
```

View File

@ -37,6 +37,7 @@ Method at API documentation: [disk.folder.rename](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.RenameFolder(URL, FolderID2, Filename2);
FolderID = "3278";
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.folder.restore](https://dev.1c-bitrix.ru/rest
Result = OPI_Bitrix24.RestoreFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -39,6 +39,7 @@ Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learnin
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -38,6 +38,7 @@ Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/lear
Result = OPI_Bitrix24.ChangeChatColor(URL, ChatID, Color);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -36,6 +36,7 @@ Method at API documentation: [im.chat.setOwner](https://dev.1c-bitrix.ru/learnin
Result = OPI_Bitrix24.ChangeChatOwner(URL, ChatID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -36,6 +36,7 @@ Method at API documentation: [im.chat.updateAvatar](https://dev.1c-bitrix.ru/lea
Result = OPI_Bitrix24.ChangeChatPicture(URL, ChatID, Image);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -36,6 +36,7 @@ Method at API documentation: [im.chat.updateTitle](https://dev.1c-bitrix.ru/lear
Result = OPI_Bitrix24.ChangeChatTitle(URL, ChatID, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -51,6 +51,8 @@ Method at API documentation: [im.chat.add](https://dev.1c-bitrix.ru/learning/cou
Result = OPI_Bitrix24.CreateChat(URL, ChatStructure);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -36,6 +36,7 @@ Method at API documentation: [im.chat.user.delete](https://dev.1c-bitrix.ru/lear
Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/co
Result = OPI_Bitrix24.DisableChatNotifications(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.chat.mute](https://dev.1c-bitrix.ru/learning/co
Result = OPI_Bitrix24.EnableChatNotifications(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.disk.folder.get](https://dev.1c-bitrix.ru/learn
Result = OPI_Bitrix24.GetChatFilesFolder(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.dialog.users.list](https://dev.1c-bitrix.ru/lea
Result = OPI_Bitrix24.GetChatMembersList(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;

View File

@ -36,11 +36,12 @@ Method at API documentation: [im.dialog.messages.get](https://dev.1c-bitrix.ru/l
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;
Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0,Token);
Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID,, 0, Token);
```

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.chat.user.list](https://dev.1c-bitrix.ru/learni
Result = OPI_Bitrix24.GetChatUsers(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.dialog.get](https://dev.1c-bitrix.ru/learning/c
Result = OPI_Bitrix24.GetDialog(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;

View File

@ -26,14 +26,14 @@ Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learn
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetUserStatus(URL);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetUserStatus(URL, Token);
```
@ -42,7 +42,7 @@ Method at API documentation: [im.user.status.get](https://dev.1c-bitrix.ru/learn
```sh title="CLI command example"
oint bitrix24 GetUserStatus --url %url% --token %token%
oint bitrix24 GetUserStatus --url %url% --token %token%
```

View File

@ -27,7 +27,7 @@ Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learni
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
ArrayOfUsers = New Array;
ArrayOfUsers.Add(1);
@ -37,8 +37,8 @@ Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learni
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserIDs = 10;
Result = OPI_Bitrix24.GetUsers(URL, UserIDs, Token);
@ -48,7 +48,7 @@ Method at API documentation: [im.user.list.get ](https://dev.1c-bitrix.ru/learni
```sh title="CLI command example"
oint bitrix24 GetUsers --url %url% --users %users% --token %token%
oint bitrix24 GetUsers --url %url% --users %users% --token %token%
```

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.chat.leave](https://dev.1c-bitrix.ru/learning/c
Result = OPI_Bitrix24.LeaveChat(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -31,6 +31,7 @@ Method at API documentation: [im.dialog.read.all](https://dev.1c-bitrix.ru/learn
Result = OPI_Bitrix24.ReadAll(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.dialog.writing](https://dev.1c-bitrix.ru/learni
Result = OPI_Bitrix24.SendWritingNotification(URL, ChatID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;

View File

@ -27,15 +27,15 @@ Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learn
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Status = "dnd";
Result = OPI_Bitrix24.SetUserStatus(URL, Status);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Status = "away";
Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);
@ -45,7 +45,7 @@ Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learn
```sh title="CLI command example"
oint bitrix24 SetUserStatus --url %url% --status %status% --token %token%
oint bitrix24 SetUserStatus --url %url% --status %status% --token %token%
```

View File

@ -37,6 +37,7 @@ Method at API documentation: [task.commentitem.add](https://dev.1c-bitrix.ru/res
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [tasks.task.result.addFromComment](https://dev.1c-b
Result = OPI_Bitrix24.CreateResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
CommentID = "2266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [tasks.task.result.deleteFromComment](https://dev.1
Result = OPI_Bitrix24.DeleteResultFromComment(URL, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
CommentID = "2266";

View File

@ -35,6 +35,7 @@ Method at API documentation: [task.commentitem.delete](https://dev.1c-bitrix.ru/
Result = OPI_Bitrix24.DeleteTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
CommentID = "2266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [tasks.task.result.list](https://dev.1c-bitrix.ru/r
Result = OPI_Bitrix24.GetResultsList(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -35,6 +35,7 @@ Method at API documentation: [task.commentitem.get](https://dev.1c-bitrix.ru/res
Result = OPI_Bitrix24.GetTaskComment(URL, TaskID, CommentID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
CommentID = "2266";

View File

@ -33,6 +33,7 @@ Method at API documentation: [task.commentitem.getlist](https://dev.1c-bitrix.ru
Result = OPI_Bitrix24.GetTaskCommentsList(URL, TaskID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -38,6 +38,7 @@ Method at API documentation: [task.commentitem.update](https://dev.1c-bitrix.ru/
Result = OPI_Bitrix24.UpdateTaskComment(URL, TaskID, CommentID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
CommentID = "2266";

View File

@ -31,15 +31,15 @@ Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Type = "date";
Name = "BIRTHDAY_FIELD";
Result = OPI_Bitrix24.AddCustomTaskField(URL, Type, Name);
URL = FunctionParameters["Bitrix24_URL"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Type = "string";
Name = "TEXT_FIELD";
@ -54,7 +54,7 @@ Method at API documentation: [task.item.userfield.add](https://dev.1c-bitrix.ru/
```sh title="CLI command example"
oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token%
oint bitrix24 AddCustomTaskField --url %url% --type %type% --fieldname %fieldname% --externalid %externalid% --title %title% --label %label% --token %token%
```

View File

@ -27,14 +27,14 @@ Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
FieldID = FunctionParameters["Bitrix24_HookTaskFieldID"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FieldID = "";
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
FieldID = FunctionParameters["Bitrix24_TaskFieldID"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
FieldID = "";
Result = OPI_Bitrix24.DeleteCustomTaskField(URL, FieldID, );
```
@ -43,7 +43,7 @@ Method at API documentation: [task.item.userfield.delete](https://dev.1c-bitrix.
```sh title="CLI command example"
oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token%
oint bitrix24 DeleteCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```

View File

@ -27,14 +27,14 @@ Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
FieldID = FunctionParameters["Bitrix24_HookTaskFieldID"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FieldID = "";
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
FieldID = FunctionParameters["Bitrix24_TaskFieldID"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
FieldID = "";
Result = OPI_Bitrix24.GetCustomTaskField(URL, FieldID, );
```
@ -43,7 +43,7 @@ Method at API documentation: [task.item.userfield.get](https://dev.1c-bitrix.ru/
```sh title="CLI command example"
oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token%
oint bitrix24 GetCustomTaskField --url %url% --fieldid %fieldid% --token %token%
```

View File

@ -26,12 +26,12 @@ Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Result = OPI_Bitrix24.GetCustomTaskFieldsList(URL);
```
@ -40,7 +40,7 @@ Method at API documentation: [task.item.userfield.getlist](https://dev.1c-bitrix
```sh title="CLI command example"
oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token%
oint bitrix24 GetCustomTaskFieldsList --url %url% --token %token%
```

View File

@ -30,17 +30,17 @@ Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FieldID = FunctionParameters["Bitrix24_HookTaskFieldID"];
FieldID = "";
Title = "New title";
Result = OPI_Bitrix24.UpdateCustomTaskField(URL, FieldID,, Title);
URL = FunctionParameters["Bitrix24_URL"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
FieldID = FunctionParameters["Bitrix24_TaskFieldID"];
FieldID = "";
ExternalID = "NEW_TEXT_FIELD";
Signature = New Structure("en,ru", "Updated field", "Izmenennoe pole");
@ -51,7 +51,7 @@ Method at API documentation: [task.item.userfield.update](https://dev.1c-bitrix.
```sh title="CLI command example"
oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token%
oint bitrix24 UpdateCustomTaskField --url %url% --fieldid %fieldid% --externalid %externalid% --title %title% --label %label% --token %token%
```

View File

@ -29,7 +29,7 @@ Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Name = "Main department";
ParentID = 1;
@ -39,11 +39,11 @@ Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Name = "Subordinate department";
ParentID = FunctionParameters["Bitrix24_HookDepID"];
ParentID = "";
HeadID = 1;
Result = OPI_Bitrix24.CreateDepartment(URL, Name, ParentID, HeadID, Token);
@ -53,7 +53,7 @@ Method at API documentation: [department.add](https://dev.1c-bitrix.ru/rest_help
```sh title="CLI command example"
oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token%
oint bitrix24 CreateDepartment --url %url% --title %title% --parentid %parentid% --headid %headid% --token %token%
```

View File

@ -27,16 +27,16 @@ Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_h
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
DepartmentID = FunctionParameters["Bitrix24_DepID"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
DepartmentID = "";
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
DepartmentID = FunctionParameters["Bitrix24_HookDepID"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
DepartmentID = "";
Result = OPI_Bitrix24.DeleteDepartment(URL, DepartmentID, Token);
```
@ -45,7 +45,7 @@ Method at API documentation: [department.delete](https://dev.1c-bitrix.ru/rest_h
```sh title="CLI command example"
oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token%
oint bitrix24 DeleteDepartment --url %url% --depid %depid% --token %token%
```

View File

@ -30,15 +30,15 @@ Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
DepartmentID = FunctionParameters["Bitrix24_DepID"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
DepartmentID = "";
Result = OPI_Bitrix24.GetDepartments(URL, DepartmentID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
HeadID = 1;
Result = OPI_Bitrix24.GetDepartments(URL,,,, HeadID, Token);
@ -48,7 +48,7 @@ Method at API documentation: [department.get](https://dev.1c-bitrix.ru/rest_help
```sh title="CLI command example"
oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
oint bitrix24 GetDepartments --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```

View File

@ -30,19 +30,19 @@ Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_h
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
DepartmentID = FunctionParameters["Bitrix24_HookDepID"];
DepartmentID = "";
ParentID = 7;
Result = OPI_Bitrix24.UpdateDepartment(URL, DepartmentID,, ParentID);
URL = FunctionParameters["Bitrix24_UR"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
DepartmentID = FunctionParameters["Bitrix24_DepID"];
DepartmentID = "";
Name = "New department";
ParentID = 1;
HeadID = 10;
@ -59,7 +59,7 @@ Method at API documentation: [department.update](https://dev.1c-bitrix.ru/rest_h
```sh title="CLI command example"
oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
oint bitrix24 UpdateDepartment --url %url% --depid %depid% --title %title% --parentid %parentid% --headid %headid% --token %token%
```

View File

@ -35,6 +35,7 @@ Method at API documentation: [log.blogcomment.add](https://dev.1c-bitrix.ru/rest
Result = OPI_Bitrix24.AddPostComment(URL, PostID, Text);
Text = "Another comment";
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -35,6 +35,7 @@ Method at API documentation: [log.blogpost.share](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.AddPostRecipients(URL, PostID, Visibility);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

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

View File

@ -33,8 +33,8 @@ Method at API documentation: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_he
```bsl title="Code example"
Text = "Text of post";
Title = "Post title";
Image1 = "https://openintegrations.dev/test_data/picture.jpg";
Image2 = "https://openintegrations.dev/test_data/picture2.jpg";
Image1 = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data
Image2 = "https://openintegrations.dev/test_data/picture2.jpg"; // URL, Path or Binary Data
Files = New Map;
Files.Insert("1.png", Image1);
@ -46,6 +46,7 @@ Method at API documentation: [log.blogpost.add](https://dev.1c-bitrix.ru/rest_he
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [log.blogpost.delete](https://dev.1c-bitrix.ru/rest
Result = OPI_Bitrix24.DeletePost(URL, PostID);
PostID = "320";
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [log.blogpost.getusers.important](https://dev.1c-bi
Result = OPI_Bitrix24.GetImportantPostViewers(URL, PostID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -34,6 +34,7 @@ Method at API documentation: [log.blogpost.get](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.GetPosts(URL, PostID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,7 +33,7 @@ Method at API documentation: [log.blogpost.update](https://dev.1c-bitrix.ru/rest
```bsl title="Code example"
Text = "New post text";
Title = "New post title";
Image1 = "https://openintegrations.dev/test_data/picture.jpg";
Image1 = "https://openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data
PostID = "320";
Files = New Map;
@ -44,6 +44,7 @@ Method at API documentation: [log.blogpost.update](https://dev.1c-bitrix.ru/rest
Result = OPI_Bitrix24.UpdatePost(URL, PostID, Text,, Files, Title);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
PostID = "318";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.file.delete](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.DeleteFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
FileID = "3272";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.file.getExternalLink](https://dev.1c-bitrix.r
Result = OPI_Bitrix24.GetFileExternalLink(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.file.get](https://dev.1c-bitrix.ru/rest_help/
Result = OPI_Bitrix24.GetFileInformation(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -36,6 +36,7 @@ Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID);
FolderID = "3278";
URL = "b24-ar17wx.bitrix24.by";
@ -43,6 +44,7 @@ Method at API documentation: [disk.file.copyto](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.MakeFileCopy(URL, FileID, FolderID, Token);
Check_BitrixObject(Result);
```

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.file.markdeleted](https://dev.1c-bitrix.ru/re
Result = OPI_Bitrix24.MarkFileAsDeleted(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -36,6 +36,7 @@ Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID);
FolderID = "3282";
URL = "b24-ar17wx.bitrix24.by";
@ -43,6 +44,7 @@ Method at API documentation: [disk.file.moveto](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.MoveFileToFolder(URL, FileID, FolderID, Token);
Check_BitrixObject(Result);
```

View File

@ -37,6 +37,7 @@ Method at API documentation: [disk.file.rename](https://dev.1c-bitrix.ru/rest_he
Result = OPI_Bitrix24.RenameFile(URL, FileID2, Filename2);
FileID = "3272";
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,6 +33,7 @@ Method at API documentation: [disk.file.restore](https://dev.1c-bitrix.ru/rest_h
Result = OPI_Bitrix24.RestoreFile(URL, FileID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -43,6 +43,7 @@ Method at API documentation: [disk.folder.uploadfile](https://dev.1c-bitrix.ru/r
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -44,6 +44,7 @@ Method at API documentation: [disk.storage.uploadfile](https://dev.1c-bitrix.ru/
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -33,13 +33,16 @@ Method at API documentation: [task.stages.add](https://dev.1c-bitrix.ru/rest_hel
```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";

View File

@ -35,6 +35,7 @@ Method at API documentation: [task.stages.delete](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.DeleteKanbanStage(URL, StageID, True);
StageID = "198";
URL = "b24-ar17wx.bitrix24.by";

View File

@ -33,6 +33,7 @@ Method at API documentation: [task.stages.get](https://dev.1c-bitrix.ru/rest_hel
Result = OPI_Bitrix24.GetKanbanStages(URL,, True);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

@ -38,6 +38,7 @@ Method at API documentation: [task.stages.movetask](https://dev.1c-bitrix.ru/res
Result = OPI_Bitrix24.MoveTaskToKanbanStage(URL, TaskID, StageID);
StageID = "198";
URL = "b24-ar17wx.bitrix24.by";

View File

@ -40,6 +40,7 @@ Method at API documentation: [task.stages.update](https://dev.1c-bitrix.ru/rest_
Result = OPI_Bitrix24.UpdateKanbansStage(URL, Name, StageID, Color);
Name = "New stage name 2";
Color = "000000";
StageID = "198";

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.message.delete](https://dev.1c-bitrix.ru/learni
Result = OPI_Bitrix24.DeleteMessage(URL, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
MessageID = "5508";

View File

@ -37,6 +37,7 @@ Method at API documentation: [im.message.update](https://dev.1c-bitrix.ru/learni
Result = OPI_Bitrix24.EditMessage(URL, MessageID, Text);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
MessageID = "5508";

View File

@ -35,12 +35,13 @@ Method at API documentation: [im.dialog.read](https://dev.1c-bitrix.ru/learning/
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, ChatID, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;
MessageID = "5508";
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID,Token);
Result = OPI_Bitrix24.MarkMessageAsReaded(URL, UserID, MessageID, Token);
```

View File

@ -35,6 +35,7 @@ Method at API documentation: [im.dialog.unread](https://dev.1c-bitrix.ru/learnin
Result = OPI_Bitrix24.MarkMessageAsUnreaded(URL, ChatID, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;

View File

@ -43,6 +43,7 @@ Method at API documentation: [im.disk.file.commit](https://dev.1c-bitrix.ru/lear
Result = OPI_Bitrix24.SendFile(URL, ChatID, FileID, Description);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
ChatID = "266";

View File

@ -43,6 +43,7 @@ Method at API documentation: [im.message.add](https://dev.1c-bitrix.ru/learning/
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
UserID = 10;

View File

@ -33,6 +33,7 @@ Method at API documentation: [im.message.like](https://dev.1c-bitrix.ru/learning
Result = OPI_Bitrix24.SetMessageReaction(URL, MessageID);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
MessageID = "5508";

View File

@ -32,7 +32,7 @@ Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/l
```bsl title="Code example"
UserID = 1;
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
@ -46,8 +46,8 @@ Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/l
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Tag = "New";
UserID = 10;
@ -58,7 +58,7 @@ Method at API documentation: [im.notify.personal.add](https://dev.1c-bitrix.ru/l
```sh title="CLI command example"
oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
oint bitrix24 CreatePersonalNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```

View File

@ -32,7 +32,7 @@ Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/lea
```bsl title="Code example"
UserID = 1;
URL = FunctionParameters["Bitrix24_URL"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
Text = "Message text";
Image = "https://raw.githubusercontent.com/Bayselonarrend/OpenIntegrations/main/service/test_data/picture.jpg";
File = "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/document.docx";
@ -46,8 +46,8 @@ Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/lea
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
Tag = "New";
UserID = 10;
@ -58,7 +58,7 @@ Method at API documentation: [im.notify.system.add](https://dev.1c-bitrix.ru/lea
```sh title="CLI command example"
oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
oint bitrix24 CreateSystemNotification --url %url% --user %user% --text %text% --tag %tag% --blocks %blocks% --token %token%
```

View File

@ -27,16 +27,16 @@ Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learnin
```bsl title="Code example"
URL = FunctionParameters["Bitrix24_URL"];
NotificationID = FunctionParameters["Bitrix24_PersoalHookNotifyID"];
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
NotificationID = "";
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
NotificationID = FunctionParameters["Bitrix24_PersoalNotifyID"];
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";
NotificationID = "";
Result = OPI_Bitrix24.DeleteNotification(URL, NotificationID, Token);
```
@ -45,7 +45,7 @@ Method at API documentation: [im.notify.delete](https://dev.1c-bitrix.ru/learnin
```sh title="CLI command example"
oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token%
oint bitrix24 DeleteNotification --url %url% --notif %notif% --token %token%
```

View File

@ -31,6 +31,7 @@ Method at API documentation: [server_time](https://dev.1c-bitrix.ru/rest_help/ge
Result = OPI_Bitrix24.ServerTime(URL);
URL = "b24-ar17wx.bitrix24.by";
Token = "adf89366006e9f06006b12e400000001000...";

View File

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

View File

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

View File

@ -1,62 +0,0 @@
---
sidebar_position: 13
---
# Delete folder
Remove folder with subfolders
`Function DeleteFolder(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | ID of folder to be deleted |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```bsl title="Code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
FolderID = "480";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID);
URL = "b24-ar17wx.bitrix24.by";
Token = "b9df7366006e9f06006b12e400000001000...";
FolderID = "482";
Result = OPI_Bitrix24.DeleteFolder(URL, FolderID, Token);
```
```sh title="CLI command example"
oint bitrix24 DeleteFolder --url "b24-ar17wx.bitrix24.by" --folderid "482" --token "b9df7366006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1719047257.50616,
"finish": 1719047257.55445,
"duration": 0.048285961151123,
"processing": 0.0174880027770996,
"date_start": "2024-06-22T09:07:37+00:00",
"date_finish": "2024-06-22T09:07:37+00:00",
"operating_reset_at": 1719047857,
"operating": 0
}
}
```

View File

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

View File

@ -1,61 +0,0 @@
---
sidebar_position: 21
---
# Get external link for a file
Get external link to file
`Function GetFileExternalLink(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,80 +0,0 @@
---
sidebar_position: 20
---
# Get information about file
Get information about file by ID
`Function GetFileInformation(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,61 +0,0 @@
---
sidebar_position: 14
---
# Get external link for folder
Get external link to folder
`Function GetFolderExternalLink(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,59 +0,0 @@
---
sidebar_position: 27
---
# Get fields structure for folder items filter
Returns filter structure for child folder items
`Function GetFolderFilterStructure(Val URL, Val Clear = False, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| Clear | --empty | Boolean | True > structure with empty values, False > field types at values |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Structure of Key-Value - Fields structure
<br/>
```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

@ -1,77 +0,0 @@
---
sidebar_position: 8
---
# Get information about folder
Get folder information
`Function GetFolderInformation(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,98 +0,0 @@
---
sidebar_position: 15
---
# Get folder child elements
Get folder child elements
`Function GetFolderItems(Val URL, Val FolderID, Val Filter = "", Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Filter | --filter | Structure of Key-Value | Items filter (see GetFolderFilterStructure) |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

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

View File

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

View File

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

View File

@ -1,87 +0,0 @@
---
sidebar_position: 24
---
# Copy file
Copy file from one destination to another
`Function MakeFileCopy(Val URL, Val FileID, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | Original file ID |
| FolderID | --folderid | String, Number | ID of copy destination folder |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,85 +0,0 @@
---
sidebar_position: 10
---
# Copy folder
Copy one folder to another
`Function MakeFolderCopy(Val URL, Val FolderID, Val DestinationID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| DestinationID | --tagetid | String, Number | ID of target folder |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,80 +0,0 @@
---
sidebar_position: 22
---
# Mark file as deleted
Move file to recycle bin
`Function MarkFileAsDeleted(Val URL, Val FileID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FileID | --fileid | String, Number | File identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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

@ -1,77 +0,0 @@
---
sidebar_position: 16
---
# Mark folder as deleted
Move folder to recycle bin
`Function MarkFolderAsDeleted(Val URL, Val FolderID, Val Token = "") Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| URL | --url | String | URL of webhook or a Bitrix24 domain, when token used |
| FolderID | --folderid | String, Number | Folder identifier |
| Token | --token | String | Access token, when not-webhook method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
```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
}
}
```

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