1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-10-08 22:51:57 +02:00

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

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

View File

@@ -6,6 +6,11 @@ sidebar_position: 8
Копирует файл или каталог по выбранному пути
<br/>
*Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,15 +22,16 @@ sidebar_position: 8
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Оригинал = "/New/pic.png";
Копия = "/New/pic_copy.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия);
```
```sh title="Пример команды CLI"
@@ -33,10 +39,8 @@ sidebar_position: 8
```
```json title="Результат"
{
{
"metadata": {
".tag": "file",
"name": "pic_copy.png",
@@ -51,5 +55,4 @@ sidebar_position: 8
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 10
Создает пустой каталог по выбранному пути
<br/>
*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -16,14 +21,15 @@ sidebar_position: 10
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/Новый каталог";
Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь);
```
```sh title="Пример команды CLI"
@@ -31,10 +37,8 @@ sidebar_position: 10
```
```json title="Результат"
{
{
"metadata": {
"name": "Новый каталог",
"path_lower": "/новый каталог",
@@ -42,5 +46,4 @@ sidebar_position: 10
"id": "id:kJU6-a-pT48AAAAAAAABZA"
}
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 7
Удаляет объект с облачного диска
<br/>
*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,14 +22,15 @@ sidebar_position: 7
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь);
```
```sh title="Пример команды CLI"
@@ -32,10 +38,8 @@ sidebar_position: 7
```
```json title="Результат"
{
{
"metadata": {
".tag": "file",
"name": "pic.png",
@@ -50,5 +54,4 @@ sidebar_position: 7
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 11
Скачивает файл по указанному пути или ID
<br/>
*Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -16,14 +21,15 @@ sidebar_position: 11
Возвращаемое значение: ДвоичныеДанные - двоичные данные файла
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/pic.png";
Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь);
```
```sh title="Пример команды CLI"
@@ -31,9 +37,6 @@ sidebar_position: 11
```
```json title="Результат"
НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00…
НЕ JSON: FF D8 FF E1 54 C1 45 78 69 66 00 00 49 49 2A 00 08 00 00 00 0B 00 0E 01 02 00 20 00 00 00 92 00 00 00 0F 01 02 00 05 00 00 00 B2 00 00 00 10 01 02 00 07 00 00 00 B8 00 00 00 12 01 03 00 01 00…
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 12
Скачивает zip архив с содержимым указанного каталога
<br/>
*Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -16,14 +21,15 @@ sidebar_position: 12
Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New";
Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь);
```
```sh title="Пример команды CLI"
@@ -31,9 +37,6 @@ sidebar_position: 12
```
```json title="Результат"
НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00…
НЕ JSON: 50 4B 03 04 14 00 00 08 00 00 36 3D BE 58 00 00 00 00 00 00 00 00 00 00 00 00 04 00 09 00 4E 65 77 2F 55 54 05 00 01 B9 2D 58 66 50 4B 03 04 14 00 08 08 00 00 4F 87 AF 58 00 00 00 00 00 00 00…
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 2
Получает список первых файлов каталога или продолжает получение следующих при указании курсора
<br/>
*Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -18,14 +23,15 @@ sidebar_position: 2
Возвращаемое значение: HTTPОтвет - Получить список файлов папки
```bsl title="Пример кода"
Путь = "/New";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина);
```
```sh title="Пример команды CLI"
@@ -33,9 +39,7 @@ sidebar_position: 2
```
```json title="Результат"
{
"entries": [
{
@@ -68,5 +72,4 @@ sidebar_position: 2
"cursor": "AAEXfuMhG6Xl2ENYH4uAoLS_nOUV4SC7ChaMxK4ZIphj9x5INumYZrHv6jqph4fgkOy6PpFTTaaJ4BTjzVGZnTk7tB5wCCp1Eogn8gCW-Agz-ej4X6ir5p-KX63vBgDV0OZ-boy78oUXMJeOtU9sjEij34BoqBCtWYOFje4PXhEV3KwVySRWzPlXSEq9arMo1AaP8PFuDxx6JTxSGRdcQwnc",
"has_more": false
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 1
Получает информацию о файле или каталоге
<br/>
*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,14 +22,15 @@ sidebar_position: 1
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина);
```
```sh title="Пример команды CLI"
@@ -32,10 +38,8 @@ sidebar_position: 1
```
```json title="Результат"
{
{
".tag": "file",
"name": "pic.png",
"path_lower": "/new/pic.png",
@@ -48,5 +52,4 @@ sidebar_position: 1
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 13
Получает список версий (ревизий) объекта
<br/>
*Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,14 +22,15 @@ sidebar_position: 13
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/pic.png";
Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1);
```
```sh title="Пример команды CLI"
@@ -32,10 +38,8 @@ sidebar_position: 13
```
```json title="Результат"
{
{
"is_deleted": false,
"entries": [
{
@@ -52,5 +56,4 @@ sidebar_position: 13
}
]
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 3
Получает PDF или HTML превью объекта (только для токументов)
<br/>
*Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -16,14 +21,15 @@ sidebar_position: 3
Возвращаемое значение: ДвоичныеДанные - превью документа
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/mydoc.docx";
Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь);
```
```sh title="Пример команды CLI"
@@ -31,9 +37,6 @@ sidebar_position: 3
```
```json title="Результат"
НЕ JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53…
НЕ JSON: 25 50 44 46 2D 31 2E 35 0D 0A 25 B5 B5 B5 B5 0D 0A 31 20 30 20 6F 62 6A 0D 0A 3C 3C 2F 54 79 70 65 2F 43 61 74 61 6C 6F 67 2F 50 61 67 65 73 20 32 20 30 20 52 2F 4C 61 6E 67 28 65 6E 2D 55 53…
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 6
Получает статус загрузки файла по URL
<br/>
*Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -16,8 +21,8 @@ sidebar_position: 6
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
ИДРаботы = "G8YbueOu2nsAAAAAAAAAAQ";
Статус = "in_progress";
@@ -31,8 +36,9 @@ sidebar_position: 6
КонецЦикла;
```
```sh title="Пример команды CLI"
@@ -40,10 +46,8 @@ sidebar_position: 6
```
```json title="Результат"
{
{
".tag": "complete",
"name": "url_doc.docx",
"path_lower": "/new/url_doc.docx",
@@ -56,5 +60,4 @@ sidebar_position: 6
"is_downloadable": true,
"content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c"
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 9
Перемещает объект по выбранному пути
<br/>
*Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,15 +22,16 @@ sidebar_position: 9
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
ОригиналныйПуть = "/New/pic.png";
ЦелевойПуть = "/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть);
```
```sh title="Пример команды CLI"
@@ -33,10 +39,8 @@ sidebar_position: 9
```
```json title="Результат"
{
{
"metadata": {
".tag": "file",
"name": "pic.png",
@@ -51,5 +55,4 @@ sidebar_position: 9
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 14
Восстанавливает состояние объекта к необходимой версии (ревизии)
<br/>
*Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,15 +22,16 @@ sidebar_position: 14
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Версия = "61a0b76320a6fbd841553";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/pic.png";
Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия);
```
```sh title="Пример команды CLI"
@@ -33,10 +39,8 @@ sidebar_position: 14
```
```json title="Результат"
{
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
@@ -48,5 +52,4 @@ sidebar_position: 14
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 5
Загружает файл на облачный диск, получая его по указанному URL
<br/>
*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -17,15 +22,16 @@ sidebar_position: 5
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/url_doc.docx";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
URL = "https://openintegrations.dev/test_data/document.docx";
Результат = OPI_Dropbox.ЗагрузитьФайлПоURL(Токен, URL, Путь);
```
```sh title="Пример команды CLI"
@@ -33,12 +39,9 @@ sidebar_position: 5
```
```json title="Результат"
{
{
".tag": "async_job_id",
"async_job_id": "41d0vPCn2mYAAAAAAAAAAQ"
}
```

View File

@@ -6,6 +6,11 @@ sidebar_position: 4
Загружает файл на облачный диск
<br/>
*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
@@ -18,8 +23,8 @@ sidebar_position: 4
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Картинка = "https://openintegrations.dev/test_data/picture.jpg";
@@ -28,8 +33,9 @@ sidebar_position: 4
КопироватьФайл(Картинка, КартинкаПуть);
Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина);
```
```sh title="Пример команды CLI"
@@ -37,10 +43,8 @@ sidebar_position: 4
```
```json title="Результат"
{
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
@@ -52,5 +56,4 @@ sidebar_position: 4
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```