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

Перевод документации

This commit is contained in:
Anton
2024-06-04 21:55:01 +03:00
parent 40a83a12cb
commit 509bd660e0
1213 changed files with 21892 additions and 19928 deletions

View File

@@ -0,0 +1,63 @@
---
sidebar_position: 4
---
# Получить информацию об аккаунте
Получает информацию об аккаунте
*Функция ПолучитьИнформациюОбАккаунте(Знач Токен, Знач Аккаунт = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Аккаунт | --account | Строка | ID аккаунта. Текущий аккаунт токена, если не заполнено |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПолучитьИнформациюОбАккаунте(Токен);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьИнформациюОбАккаунте --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --account %account%
```
```json title="Результат"
{
"account_id": "dbid:AAA4WKMCfgoW5LwuNQFeLOyp-X4omQiNDhE",
"name": {
"given_name": "Антон",
"surname": "Титовец",
"familiar_name": "Антон",
"display_name": "Антон Титовец",
"abbreviated_name": "АТ"
},
"email": "bayselonarrend@gmail.com",
"email_verified": true,
"disabled": false,
"country": "BY",
"locale": "en",
"referral_link": "https://www.dropbox.com/referrals/AADQceVD6l02CM1dzgLM7s_o8gdaPXKc7oM?src=app9-2724483",
"is_paired": false,
"account_type": {
".tag": "basic"
},
"root_info": {
".tag": "user",
"root_namespace_id": "3179550035",
"home_namespace_id": "3179550035"
}
}
```

View File

@@ -0,0 +1,37 @@
---
sidebar_position: 1
---
# Получить ссылку авторизации
Генерирует ссылку авторизации для перехода в браузере
*Функция ПолучитьСсылкуАвторизации(Знач КлючПриложения) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| КлючПриложения | --appkey | Строка | Ключ приложения |
Возвращаемое значение: Строка - URL для перехода в браузере
```bsl title="Пример кода"
КлючПриложения = "oynqxds...";
Результат = OPI_Dropbox.ПолучитьСсылкуАвторизации(КлючПриложения);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьСсылкуАвторизации --appkey "oynqxds..."
```
```json title="Результат"
"https://www.dropbox.com/oauth2/authorize?client_id=oynqxdsqft8oyky&response_type=code&token_access_type=offline"
```

View File

@@ -0,0 +1,44 @@
---
sidebar_position: 5
---
# Получить данные использования пространства
Получает информацию о количестве использованного дискового пространства
*Функция ПолучитьДанныеИспользованияПространства(Знач Токен) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПолучитьДанныеИспользованияПространства(Токен);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьДанныеИспользованияПространства --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..."
```
```json title="Результат"
{
"used": 1477493597,
"allocation": {
".tag": "individual",
"allocated": 2147483648
}
}
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 2
---
# Получить токен
Полеучает токен на основе кода со страницы ПолучитьСсылкуАвторизации
*Функция ПолучитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач Код) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| КлючПриложения | --appkey | Строка | Ключ приложения |
| СекретПриложения | --appsecret | Строка | Секрет приложения |
| Код | --code | Строка | Код со страницы авторизации |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
КлючПриложения = "oynqxds...";
СекретПриложения = "tk2oewn...";
Код = "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8";
Результат = OPI_Dropbox.ПолучитьТокен(КлючПриложения, СекретПриложения, Код);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьТокен --appkey "oynqxds..." --appsecret "tk2oewn..." --code "bTCiUTzxe6kAAAAAAAAAGN1NMZIxyqETKr4o7OS2dU8"
```
```json title="Результат"
{
"error": "invalid_grant",
"error_description": "code doesn't exist or has expired"
}
```

View File

@@ -0,0 +1,46 @@
---
sidebar_position: 3
---
# Обновить токен
Получает новый токен на основе рефреш токена
*Функция ОбновитьТокен(Знач КлючПриложения, Знач СекретПриложения, Знач РефрешТокен) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| КлючПриложения | --appkey | Строка | Ключ приложения |
| СекретПриложения | --appsecret | Строка | Секрет приложения |
| РефрешТокен | --refresh | Строка | Рефреш токен |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
КлючПриложения = "oynqxds...";
СекретПриложения = "tk2oewn...";
РефрешТокен = "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV...";
Результат = OPI_Dropbox.ОбновитьТокен(КлючПриложения, СекретПриложения, РефрешТокен);
```
```sh title="Пример команды CLI"
oint dropbox ОбновитьТокен --appkey "oynqxds..." --appsecret "tk2oewn..." --refresh "oZFWg3DmZ_IAAAAAAAAAAWilOA0M1SjV..."
```
```json title="Результат"
{
"access_token": "sl.B2M8yVLTS_ojO3UsFs2tRlXxkFh50RLOkroi3SLCwcjA2xX58JY__GXKh9vPGnGcfDkkTJJYB1Wn9tFvj6cRs3w04TnfaBQnJiOfUb58UHexTCAdck9xNFIBAQjuAQKUtkoht66bvsu4oh6Wl6gQpvU",
"token_type": "bearer",
"expires_in": 14400
}
```

View File

@@ -0,0 +1,4 @@
{
"label": "Account and authorization",
"position": ""
}

View File

@@ -0,0 +1,56 @@
---
sidebar_position: 8
---
# Копировать объект
Копирует файл или каталог по выбранному пути
*Функция КопироватьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Откуда | --form | Строка | Путь к объекту оригинала |
| Куда | --to | Строка | Целевой путь для нового объекта |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Оригинал = "/New/pic.png";
Копия = "/New/pic_copy.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.КопироватьОбъект(Токен, Оригинал, Копия);
```
```sh title="Пример команды CLI"
oint dropbox КопироватьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Результат"
{
"metadata": {
".tag": "file",
"name": "pic_copy.png",
"path_lower": "/new/pic_copy.png",
"path_display": "/New/pic_copy.png",
"id": "id:kJU6-a-pT48AAAAAAAABYg",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:54Z",
"rev": "619ab10ed491ebd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

View File

@@ -0,0 +1,47 @@
---
sidebar_position: 10
---
# Создать папку
Создает пустой каталог по выбранному пути
*Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Целевой путь создания каталога |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/Новый каталог";
Результат = OPI_Dropbox.СоздатьПапку(Токен, Путь);
```
```sh title="Пример команды CLI"
oint dropbox СоздатьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Результат"
{
"metadata": {
"name": "Новый каталог",
"path_lower": "/новый каталог",
"path_display": "/Новый каталог",
"id": "id:kJU6-a-pT48AAAAAAAABZA"
}
}
```

View File

@@ -0,0 +1,55 @@
---
sidebar_position: 7
---
# Удалить объект
Удаляет объект с облачного диска
*Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач Безвозвратно = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту удаления |
| БезВозвратно | --permanently | Строка | Удалить объект без возможности востановления |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.УдалитьОбъект(Токен, Путь);
```
```sh title="Пример команды CLI"
oint dropbox УдалитьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --permanently %permanently%
```
```json title="Результат"
{
"metadata": {
".tag": "file",
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:48Z",
"rev": "619ab108e3d3dbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
}
```

View File

@@ -0,0 +1,40 @@
---
sidebar_position: 11
---
# Скачать файл
Скачивает файл по указанному пути или ID
*Функция СкачатьФайл(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь или ID файла |
Возвращаемое значение: ДвоичныеДанные - двоичные данные файла
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/pic.png";
Результат = OPI_Dropbox.СкачатьФайл(Токен, Путь);
```
```sh title="Пример команды CLI"
oint dropbox СкачатьФайл --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png"
```
```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…
```

View File

@@ -0,0 +1,40 @@
---
sidebar_position: 12
---
# Скачать папку
Скачивает zip архив с содержимым указанного каталога
*Функция СкачатьПапку(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь или ID каталога |
Возвращаемое значение: ДвоичныеДанные - двоичные данные zip архива с содержимым каталога
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New";
Результат = OPI_Dropbox.СкачатьПапку(Токен, Путь);
```
```sh title="Пример команды CLI"
oint dropbox СкачатьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New"
```
```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…
```

View File

@@ -0,0 +1,42 @@
---
sidebar_position: 2
---
# Получить список файлов папки
Получает список первых файлов каталога или продолжает получение следующих при указании курсора
*Функция ПолучитьСписокФайловПапки(Знач Токен, Знач Путь = "", Знач Подробно = Ложь, Знач Курсор = "") Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к каталогу. Необязателен, если указан курсор |
| Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов |
| Курсор | --cursor | Строка | Курсор из предыдущего запроса для получения следующего набора файлов |
Возвращаемое значение: HTTPОтвет - Получить список файлов папки
```bsl title="Пример кода"
Путь = "/New";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПолучитьСписокФайловПапки(Токен, Путь, Истина);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьСписокФайловПапки --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New" --detail %detail% --cursor %cursor%
```
```json title="Результат"
```

View File

@@ -0,0 +1,53 @@
---
sidebar_position: 1
---
# Получить информацию об объекте
Получает информацию о файле или каталоге
*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Путь, Знач Подробно = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту |
| Подробно | --detail | Булево | Добавляет дополнительные поля информации для медиафайлов |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПолучитьИнформациюОбОбъекте(Токен, Путь, Истина);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьИнформациюОбОбъекте --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --detail %detail%
```
```json title="Результат"
{
".tag": "file",
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

View File

@@ -0,0 +1,57 @@
---
sidebar_position: 13
---
# Получить список версий объекта
Получает список версий (ревизий) объекта
*Функция ПолучитьСписокВерсийОбъекта(Знач Токен, Знач Путь, Знач Количество = 10) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту |
| Количество | --amount | Строка, Число | Число последних версий объекта для отображения |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/pic.png";
Результат = OPI_Dropbox.ПолучитьСписокВерсийОбъекта(Токен, Путь, 1);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьСписокВерсийОбъекта --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --amount %amount%
```
```json title="Результат"
{
"is_deleted": false,
"entries": [
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
]
}
```

View File

@@ -0,0 +1,40 @@
---
sidebar_position: 3
---
# Получить превью
Получает PDF или HTML превью объекта (только для токументов)
*Функция ПолучитьПревью(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту |
Возвращаемое значение: ДвоичныеДанные - превью документа
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/mydoc.docx";
Результат = OPI_Dropbox.ПолучитьПревью(Токен, Путь);
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьПревью --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/mydoc.docx"
```
```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…
```

View File

@@ -0,0 +1,62 @@
---
sidebar_position: 6
---
# Получить статус загрузки по URL
Получает статус загрузки файла по URL
*Функция ПолучитьСтатусЗагрузкиПоURL(Знач Токен, Знач IDРаботы) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| IDРаботы | --job | Строка | ID асинхронной работы из ответа ЗагрузитьФайлПоURL |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
ИДРаботы = "G8YbueOu2nsAAAAAAAAAAQ";
Статус = "in_progress";
Пока Статус = "in_progress" Цикл
Результат = OPI_Dropbox.ПолучитьСтатусЗагрузкиПоURL(Токен, ИДРаботы);
Статус = Результат[".tag"];
OPI_Инструменты.Пауза(5);
OPI_ПолучениеДанныхТестов.ЗаписатьЛог(Результат, "ПолучитьСтатусЗагрузкиПоURL", "Dropbox");
КонецЦикла;
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьСтатусЗагрузкиПоURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job%
```
```json title="Результат"
{
".tag": "complete",
"name": "url_doc.docx",
"path_lower": "/new/url_doc.docx",
"path_display": "/New/url_doc.docx",
"id": "id:kJU6-a-pT48AAAAAAAABYw",
"client_modified": "2024-05-30T12:33:07Z",
"server_modified": "2024-05-30T12:33:08Z",
"rev": "619ab11c37fb9bd841553",
"size": 24069,
"is_downloadable": true,
"content_hash": "8d63c5989ceec1a90f3fde2ffaa76efcd2c050191e6b55a1761e4e352590bd8c"
}
```

View File

@@ -0,0 +1,42 @@
---
sidebar_position: 9
---
# Переместить объект
Перемещает объект по выбранному пути
*Функция ПереместитьОбъект(Знач Токен, Знач Откуда, Знач Куда) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Откуда | --form | Строка | Путь к объекту оригинала |
| Куда | --to | Строка | Целевой путь для нового объекта |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
ОригиналныйПуть = "/New/pic.png";
ЦелевойПуть = "/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Результат = OPI_Dropbox.ПереместитьОбъект(Токен, ОригиналныйПуть, ЦелевойПуть);
```
```sh title="Пример команды CLI"
oint dropbox ПереместитьОбъект --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Результат"
```

View File

@@ -0,0 +1,53 @@
---
sidebar_position: 14
---
# Восстановить объект к версии
Восстанавливает состояние объекта к необходимой версии (ревизии)
*Функция ВосстановитьОбъектКВерсии(Знач Токен, Знач Путь, Знач Версия) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту |
| Версия | --rev | Строка | ID версии (ревизии) для востановления |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Версия = "61a0b76320a6fbd841553";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/pic.png";
Результат = OPI_Dropbox.ВосстановитьОбъектКВерсии(Токен, Путь, Версия);
```
```sh title="Пример команды CLI"
oint dropbox ВосстановитьОбъектКВерсии --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/pic.png" --rev "61a0b76320a6fbd841553"
```
```json title="Результат"
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

View File

@@ -0,0 +1,45 @@
---
sidebar_position: 5
---
# Загрузить файл по URL
Загружает файл на облачный диск, получая его по указанному URL
*Функция ЗагрузитьФайлПоURL(Знач Токен, Знач URLФайла, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| URLФайла | --url | Строка | URL источник файла |
| Путь | --path | Строка | Путь сохранения на Dropbox |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный 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"
oint dropbox ЗагрузитьФайлПоURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path "/New/url_doc.docx"
```
```json title="Результат"
{
".tag": "async_job_id",
"async_job_id": "41d0vPCn2mYAAAAAAAAAAQ"
}
```

View File

@@ -0,0 +1,57 @@
---
sidebar_position: 4
---
# Загрузить файл
Загружает файл на облачный диск
*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Путь, Знач Перезаписывать = Ложь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Файл | --file | Строка, ДвоичныеДанные | Данные файл для загрузки |
| Путь | --path | Строка | Путь сохранения на Dropbox |
| Перезаписывать | --overwrite | Булево | Перезаписывать файл при конфликте путей |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Путь = "/New/pic.png";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Картинка = "https://openintegrations.dev/test_data/picture.jpg";
КартинкаПуть = ПолучитьИмяВременногоФайла("png");
КопироватьФайл(Картинка, КартинкаПуть);
Результат = OPI_Dropbox.ЗагрузитьФайл(Токен, КартинкаПуть, Путь, Истина);
```
```sh title="Пример команды CLI"
oint dropbox ЗагрузитьФайл --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path "/New/pic.png" --overwrite %overwrite%
```
```json title="Результат"
{
"name": "pic.png",
"path_lower": "/new/pic.png",
"path_display": "/New/pic.png",
"id": "id:kJU6-a-pT48AAAAAAAABYA",
"client_modified": "2024-05-30T12:32:09Z",
"server_modified": "2024-05-30T12:32:09Z",
"rev": "619ab0e44a57cbd841553",
"size": 2114023,
"is_downloadable": true,
"content_hash": "0f3b18c255b0f252bd326cacc04c15c3aa57bd6b8234adb65aa7bb2987a65492"
}
```

View File

@@ -0,0 +1,4 @@
{
"label": "File and directory management",
"position": ""
}

View File

@@ -0,0 +1,43 @@
---
sidebar_position: 3
---
# Добавить пользователя к файлу
Определяет доступ к файлу для стороннего пользователя
*Функция ДобавитьПользователейКФайлу(Знач Токен, Знач IDФайла, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ |
| АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей |
| ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Почта = "h5bk6ft62s@privaterelay.appleid.com";
Файл = "kJU6-a-pT48AAAAAAAAABw";
Результат = OPI_Dropbox.ДобавитьПользователейКФайлу(Токен, Файл, Почта, Ложь);
```
```sh title="Пример команды CLI"
oint dropbox ДобавитьПользователейКФайлу --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly%
```
```json title="Результат"
```

View File

@@ -0,0 +1,43 @@
---
sidebar_position: 4
---
# Добавить пользователей к папке
Предоставляет стороннии пользователям доступ к каталогу
*Функция ДобавитьПользователейКПапке(Знач Токен, Знач IDПапки, Знач АдресаПочты, Знач ТолькоПросмотр = Истина) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) |
| АдресаПочты | --emails | Строка, Массив Из Строка | Список адресов почты добавляемых пользователей |
| ТолькоПросмотр | --readonly | Булево | Запрещает редактирование файла для стороннего пользователя |
Возвращаемое значение: Неопределено - пустой ответ
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Почта = "h5bk6ft62s@privaterelay.appleid.com";
Папка = "5022319569"; // shared_folder_id
Результат = OPI_Dropbox.ДобавитьПользователейКПапке(Токен, Папка, Почта, Ложь);
```
```sh title="Пример команды CLI"
oint dropbox ДобавитьПользователейКПапке --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder% --emails %emails% --readonly %readonly%
```
```json title="Результат"
```

View File

@@ -0,0 +1,40 @@
---
sidebar_position: 6
---
# Отменить публикацию файла
Запрещает доступ к файлу для внешних пользователей
*Функция ОтменитьПубликациюФайла(Знач Токен, Знач IDФайла) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| IDФайла | --fileid | Строка | ID файла, к которому предоставляется доступ |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Файл = "kJU6-a-pT48AAAAAAAAABw";
Результат = OPI_Dropbox.ОтменитьПубликациюФайла(Токен, Файл);
```
```sh title="Пример команды CLI"
oint dropbox ОтменитьПубликациюФайла --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid%
```
```json title="Результат"
{}
```

View File

@@ -0,0 +1,50 @@
---
sidebar_position: 2
---
# Отменить публикацию папки
Отменяет режим общего доступа для каталога
*Функция ОтменитьПубликациюПапки(Знач Токен, Знач IDПапки) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| IDПапки | --folder | Строка | ID публичного каталога (shared folder ID) |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Папка = "5022319569";
Результат = OPI_Dropbox.ОтменитьПубликациюПапки(Токен, Папка);
ТекущийСтатус = "in_progress";
IDРаботы = Результат["async_job_id"];
Пока ТекущийСтатус = "in_progress" Цикл
Результат = OPI_Dropbox.ПолучитьСтатусАсинхронногоИзменения(Токен, IDРаботы);
ТекущийСтатус = Результат[".tag"];
OPI_Инструменты.Пауза(3);
КонецЦикла;
```
```sh title="Пример команды CLI"
oint dropbox ОтменитьПубликациюПапки --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --folder %folder%
```
```json title="Результат"
{
".tag": "complete"
}
```

View File

@@ -0,0 +1,36 @@
---
sidebar_position: 5
---
# Получить статус асинхронного изменения
Получает статус асинхронной работы по изменению доступов
*Функция ПолучитьСтатусАсинхронногоИзменения(Знач Токен, Знач IDРаботы) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| IDРаботы | --job | Строка | ID асинхронной работы |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьСтатусАсинхронногоИзменения --token %token% --job %job%
```
```json title="Результат"
```

View File

@@ -0,0 +1,68 @@
---
sidebar_position: 1
---
# Опубликовать папку
Переводит каталог в режим публичного доступа
*Функция ОпубликоватьПапку(Знач Токен, Знач Путь) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к целевому каталогу |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New";
Результат = OPI_Dropbox.ОпубликоватьПапку(Токен, Путь);
```
```sh title="Пример команды CLI"
oint dropbox ОпубликоватьПапку --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New"
```
```json title="Результат"
{
".tag": "complete",
"access_type": {
".tag": "owner"
},
"is_inside_team_folder": false,
"is_team_folder": false,
"path_display": "/New",
"path_lower": "/new",
"name": "New",
"policy": {
"acl_update_policy": {
".tag": "editors"
},
"shared_link_policy": {
".tag": "anyone"
},
"viewer_info_policy": {
".tag": "enabled"
}
},
"preview_url": "https://www.dropbox.com/scl/fo/0eu3zz5f05vymefoq6yyl/h?dl=0",
"shared_folder_id": "5009428129",
"time_invited": "2024-05-30T12:35:34Z",
"access_inheritance": {
".tag": "inherit"
},
"folder_id": "id:kJU6-a-pT48AAAAAAAABXw"
}
```

View File

@@ -0,0 +1,4 @@
{
"label": "Shared access settings",
"position": ""
}

View File

@@ -0,0 +1,42 @@
---
sidebar_position: 2
---
# Добавить тег
Добавляет новый текстовый тег к файлу или каталогу
*Функция ДобавитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту, для которого необходимо создать тег |
| Тег | --tag | Строка | Текст тега |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Тег = "Важное";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/mydoc.docx";
Результат = OPI_Dropbox.ДобавитьТег(Токен, Путь, Тег);
```
```sh title="Пример команды CLI"
oint dropbox ДобавитьТег --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/mydoc.docx" --tag "Важное"
```
```json title="Результат"
{}
```

View File

@@ -0,0 +1,42 @@
---
sidebar_position: 3
---
# Удалить тег
Удаляет текстовый тег файла или каталога
*Функция УдалитьТег(Знач Токен, Знач Путь, Знач Тег) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Путь | --path | Строка | Путь к объекту, тег которого необходимо удалить |
| Тег | --tag | Строка | Текст тега |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
Тег = "Важное";
Токен = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Путь = "/New/mydoc.docx";
Результат = OPI_Dropbox.УдалитьТег(Токен, Путь, Тег);
```
```sh title="Пример команды CLI"
oint dropbox УдалитьТег --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path "/New/mydoc.docx" --tag "Важное"
```
```json title="Результат"
{}
```

View File

@@ -0,0 +1,52 @@
---
sidebar_position: 1
---
# Получить список тегов
Получает список тегов выбранных файлов
*Функция ПолучитьСписокТегов(Знач Токен, Знач Пути) Экспорт*
| Параметр | CLI опция | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен |
| Пути | --paths | Строка, Массив Из Строка | Путь или набору путей к файлам |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Dropbox
```bsl title="Пример кода"
```
```sh title="Пример команды CLI"
oint dropbox ПолучитьСписокТегов --token %token% --paths %paths%
```
```json title="Результат"
{
"paths_to_tags": [
{
"path": "/New/Dogs.mp3",
"tags": []
},
{
"path": "/New/mydoc.docx",
"tags": [
{
".tag": "user_generated_tag",
"tag_text": "важное"
}
]
}
]
}
```

View File

@@ -0,0 +1,4 @@
{
"label": "Tag work",
"position": ""
}