1c/OpenIntegrations
1
0
Fork 0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-12-01 22:29:52 +02:00
Code Issues Releases Activity

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

Browse Source
This commit is contained in:
Vitaly the Alpaca
2024-06-05 10:19:46 +00:00
committed by Vitaly the Alpaca (bot)
parent 9c2d012d41
commit 09822c04ec
597 changed files with 41032 additions and 41032 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
docs/en/md/Dropbox/File-and-directory-management/Copy-object.md
View File

@@ -1,57 +1,57 @@
---
sidebar_position: 8
---
# Copy object
Copies a file or directory to the selected path
*Function CopyObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Original = "/New/pic.png";
Copy = "/New/pic_copy.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.CopyObject(Token, Original, Copy);
```
```sh title="CLI command example"
oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Result"
{
"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"
}
}
```
---
sidebar_position: 8
---
# Copy object
Copies a file or directory to the selected path
*Function CopyObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Original = "/New/pic.png";
Copy = "/New/pic_copy.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.CopyObject(Token, Original, Copy);
```
```sh title="CLI command example"
oint dropbox CopyObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Result"
{
"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"
}
}
```

96
docs/en/md/Dropbox/File-and-directory-management/Create-folder.md
View File

@@ -1,48 +1,48 @@
---
sidebar_position: 10
---
# Create folder
Creates an empty directory at the selected path
*Function CreateFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Target path for creating the directory |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New catalog";
Result = OPI_Dropbox.CreateFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
{
"metadata": {
"name": "New catalog",
"path_lower": "/new catalog",
"path_display": "/New catalog",
"id": "id:kJU6-a-pT48AAAAAAAABZA"
}
}
```
---
sidebar_position: 10
---
# Create folder
Creates an empty directory at the selected path
*Function CreateFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Target path for creating the directory |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New catalog";
Result = OPI_Dropbox.CreateFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox CreateFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
{
"metadata": {
"name": "New catalog",
"path_lower": "/new catalog",
"path_display": "/New catalog",
"id": "id:kJU6-a-pT48AAAAAAAABZA"
}
}
```

112
docs/en/md/Dropbox/File-and-directory-management/Delete-object.md
View File

@@ -1,56 +1,56 @@
---
sidebar_position: 7
---
# Delete object
Deletes an object from the cloud drive
*Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object to delete |
| Irrecoverable | --permanently | String | Delete object without the possibility of recovery |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.DeleteObject(Token, Path);
```
```sh title="CLI command example"
oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently%
```
```json title="Result"
{
"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"
}
}
```
---
sidebar_position: 7
---
# Delete object
Deletes an object from the cloud drive
*Function DeleteObject(Val Token, Val Path, Val Irrecoverable = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object to delete |
| Irrecoverable | --permanently | String | Delete object without the possibility of recovery |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.DeleteObject(Token, Path);
```
```sh title="CLI command example"
oint dropbox DeleteObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --permanently %permanently%
```
```json title="Result"
{
"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"
}
}
```

82
docs/en/md/Dropbox/File-and-directory-management/Download-file.md
View File

@@ -1,41 +1,41 @@
---
sidebar_position: 11
---
# Download file
Downloads a file by the specified path or ID
*Function DownloadFile(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path or ID of the file |
Returns: BinaryData - binary data of the file
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.DownloadFile(Token, Path);
```
```sh title="CLI command example"
oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
NOT 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…
```
---
sidebar_position: 11
---
# Download file
Downloads a file by the specified path or ID
*Function DownloadFile(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path or ID of the file |
Returns: BinaryData - binary data of the file
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.DownloadFile(Token, Path);
```
```sh title="CLI command example"
oint dropbox DownloadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
NOT 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…
```

82
docs/en/md/Dropbox/File-and-directory-management/Download-folder.md
View File

@@ -1,41 +1,41 @@
---
sidebar_position: 12
---
# Download folder
Downloads a zip archive with the contents of the specified directory
*Function DownloadFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path or ID of the directory |
Returns: BinaryData - binary data of the zip archive with the contents of the directory
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New";
Result = OPI_Dropbox.DownloadFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
NOT 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…
```
---
sidebar_position: 12
---
# Download folder
Downloads a zip archive with the contents of the specified directory
*Function DownloadFolder(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path or ID of the directory |
Returns: BinaryData - binary data of the zip archive with the contents of the directory
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New";
Result = OPI_Dropbox.DownloadFolder(Token, Path);
```
```sh title="CLI command example"
oint dropbox DownloadFolder --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
NOT 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…
```

86
docs/en/md/Dropbox/File-and-directory-management/Get-list-of-folder-files.md
View File

@@ -1,43 +1,43 @@
---
sidebar_position: 2
---
# Get list of folder files
Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified
*Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the directory. Optional if the cursor is specified |
| Detailed | --detail | Boolean | Adds additional information fields for media files |
| Cursor | --cursor | String | Cursor from the previous request to get the next set of files |
Returns: HTTPResponse - Get list of folder files
```bsl title="Code example"
Path = "/New";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True);
```
```sh title="CLI command example"
oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor%
```
```json title="Result"
```
---
sidebar_position: 2
---
# Get list of folder files
Gets the list of the first files in the directory or continues getting the next ones when the cursor is specified
*Function GetListOfFolderFiles(Val Token, Val Path = "", Val Detailed = False, Val Cursor = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the directory. Optional if the cursor is specified |
| Detailed | --detail | Boolean | Adds additional information fields for media files |
| Cursor | --cursor | String | Cursor from the previous request to get the next set of files |
Returns: HTTPResponse - Get list of folder files
```bsl title="Code example"
Path = "/New";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetListOfFolderFiles(Token, Path, True);
```
```sh title="CLI command example"
oint dropbox GetListOfFolderFiles --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail% --cursor %cursor%
```
```json title="Result"
```

108
docs/en/md/Dropbox/File-and-directory-management/Get-object-information.md
View File

@@ -1,54 +1,54 @@
---
sidebar_position: 1
---
# Get object information
Gets information about a file or directory
*Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Detailed | --detail | Boolean | Adds additional information fields for media files |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetObjectInformation(Token, Path, True);
```
```sh title="CLI command example"
oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail%
```
```json title="Result"
{
".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"
}
```
---
sidebar_position: 1
---
# Get object information
Gets information about a file or directory
*Function GetObjectInformation(Val Token, Val Path, Val Detailed = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Detailed | --detail | Boolean | Adds additional information fields for media files |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.GetObjectInformation(Token, Path, True);
```
```sh title="CLI command example"
oint dropbox GetObjectInformation --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --detail %detail%
```
```json title="Result"
{
".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"
}
```

116
docs/en/md/Dropbox/File-and-directory-management/Get-object-version-list.md
View File

@@ -1,58 +1,58 @@
---
sidebar_position: 13
---
# Get list of object versions
Gets the list of versions (revisions) of the object
*Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Count | --amount | String, Number | Number of the latest versions of the object to display |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1);
```
```sh title="CLI command example"
oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount%
```
```json title="Result"
{
"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"
}
]
}
```
---
sidebar_position: 13
---
# Get list of object versions
Gets the list of versions (revisions) of the object
*Function GetObjectVersionList(Val Token, Val Path, Val Count = 10) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Count | --amount | String, Number | Number of the latest versions of the object to display |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.GetObjectVersionList(Token, Path, 1);
```
```sh title="CLI command example"
oint dropbox GetObjectVersionList --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --amount %amount%
```
```json title="Result"
{
"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"
}
]
}
```

82
docs/en/md/Dropbox/File-and-directory-management/Get-preview.md
View File

@@ -1,41 +1,41 @@
---
sidebar_position: 3
---
# Get preview
Gets PDF or HTML preview of the object (for documents only)
*Function GetPreview(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
Returns: BinaryData - document preview
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx";
Result = OPI_Dropbox.GetPreview(Token, Path);
```
```sh title="CLI command example"
oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
NOT 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…
```
---
sidebar_position: 3
---
# Get preview
Gets PDF or HTML preview of the object (for documents only)
*Function GetPreview(Val Token, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
Returns: BinaryData - document preview
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/mydoc.docx";
Result = OPI_Dropbox.GetPreview(Token, Path);
```
```sh title="CLI command example"
oint dropbox GetPreview --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path%
```
```json title="Result"
NOT 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…
```

124
docs/en/md/Dropbox/File-and-directory-management/Get-upload-status-by-url.md
View File

@@ -1,62 +1,62 @@
---
sidebar_position: 6
---
# Get upload status by URL
Gets the upload status of the file by URL
*Function GetUploadStatusByURL(Val Token, Val JobID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
WorkID = "G8YbueOu2nsAAAAAAAAAAQ";
Status = "in_progress";
WHile Status = "in_progress" Do
Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID);
Status = Result[".tag"];
OPI_Tools.Pause(5);
EndDo;
```
```sh title="CLI command example"
oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job%
```
```json title="Result"
{
".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"
}
```
---
sidebar_position: 6
---
# Get upload status by URL
Gets the upload status of the file by URL
*Function GetUploadStatusByURL(Val Token, Val JobID) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| JobID | --job | String | ID of the asynchronous job from the UploadFileByURL response |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
WorkID = "G8YbueOu2nsAAAAAAAAAAQ";
Status = "in_progress";
WHile Status = "in_progress" Do
Result = OPI_Dropbox.GetUploadStatusByURL(Token, WorkID);
Status = Result[".tag"];
OPI_Tools.Pause(5);
EndDo;
```
```sh title="CLI command example"
oint dropbox GetUploadStatusByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --job %job%
```
```json title="Result"
{
".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"
}
```

86
docs/en/md/Dropbox/File-and-directory-management/Move-object.md
View File

@@ -1,43 +1,43 @@
---
sidebar_position: 9
---
# Move object
Moves an object to the selected path
*Function MoveObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
OriginalPath = "/New/pic.png";
TargetPath = "/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath);
```
```sh title="CLI command example"
oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Result"
```
---
sidebar_position: 9
---
# Move object
Moves an object to the selected path
*Function MoveObject(Val Token, Val From, Val Target) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --form | String | Path to the original object |
| Target | --to | String | Target path for the new object |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
OriginalPath = "/New/pic.png";
TargetPath = "/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Result = OPI_Dropbox.MoveObject(Token, OriginalPath, TargetPath);
```
```sh title="CLI command example"
oint dropbox MoveObject --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --form %form% --to %to%
```
```json title="Result"
```

108
docs/en/md/Dropbox/File-and-directory-management/Restore-object-to-version.md
View File

@@ -1,54 +1,54 @@
---
sidebar_position: 14
---
# Restore object to version
Restores object state to required version (revision)
*Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Version | --rev | String | ID of the version (revision) for restoration |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Version = "61a0b76320a6fbd841553";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version);
```
```sh title="CLI command example"
oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553"
```
```json title="Result"
{
"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"
}
```
---
sidebar_position: 14
---
# Restore object to version
Restores object state to required version (revision)
*Function RestoreObjectToVersion(Val Token, Val Path, Val Version) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Path | --path | String | Path to the object |
| Version | --rev | String | ID of the version (revision) for restoration |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Version = "61a0b76320a6fbd841553";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Path = "/New/pic.png";
Result = OPI_Dropbox.RestoreObjectToVersion(Token, Path, Version);
```
```sh title="CLI command example"
oint dropbox RestoreObjectToVersion --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --path %path% --rev "61a0b76320a6fbd841553"
```
```json title="Result"
{
"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"
}
```

92
docs/en/md/Dropbox/File-and-directory-management/Upload-file-by-url.md
View File

@@ -1,46 +1,46 @@
---
sidebar_position: 5
---
# Upload file by URL
Uploads a file to the cloud drive by fetching it from the specified URL
*Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FileURL | --url | String | URL source of the file |
| Path | --path | String | Save path on Dropbox |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/url_doc.docx";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
URL = "https://openintegrations.dev/test_data/document.docx";
Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path);
```
```sh title="CLI command example"
oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path%
```
```json title="Result"
{
".tag": "async_job_id",
"async_job_id": "41d0vPCn2mYAAAAAAAAAAQ"
}
```
---
sidebar_position: 5
---
# Upload file by URL
Uploads a file to the cloud drive by fetching it from the specified URL
*Function UploadFileByURL(Val Token, Val FileURL, Val Path) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| FileURL | --url | String | URL source of the file |
| Path | --path | String | Save path on Dropbox |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/url_doc.docx";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
URL = "https://openintegrations.dev/test_data/document.docx";
Result = OPI_Dropbox.UploadFileByURL(Token, URL, Path);
```
```sh title="CLI command example"
oint dropbox UploadFileByURL --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --url %url% --path %path%
```
```json title="Result"
{
".tag": "async_job_id",
"async_job_id": "41d0vPCn2mYAAAAAAAAAAQ"
}
```

116
docs/en/md/Dropbox/File-and-directory-management/Upload-file.md
View File

@@ -1,58 +1,58 @@
---
sidebar_position: 4
---
# Upload file
Uploads a file to the cloud drive
*Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| File | --file | String, BinaryData | Data file for upload |
| Path | --path | String | Save path on Dropbox |
| Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Image = "https://openintegrations.dev/test_data/picture.jpg";
ImagePath = GetTempFileName("png");
CopyFile(Image, ImagePath);
Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True);
```
```sh title="CLI command example"
oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite%
```
```json title="Result"
{
"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"
}
```
---
sidebar_position: 4
---
# Upload file
Uploads a file to the cloud drive
*Function UploadFile(Val Token, Val File, Val Path, Val Overwrite = False) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| File | --file | String, BinaryData | Data file for upload |
| Path | --path | String | Save path on Dropbox |
| Overwrite | --overwrite | Boolean | Overwrite file in case of path conflicts |
Returns: Key-Value Pair - serialized JSON response from Dropbox
```bsl title="Code example"
Path = "/New/pic.png";
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
Image = "https://openintegrations.dev/test_data/picture.jpg";
ImagePath = GetTempFileName("png");
CopyFile(Image, ImagePath);
Result = OPI_Dropbox.UploadFile(Token, ImagePath, Path, True);
```
```sh title="CLI command example"
oint dropbox UploadFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --file %file% --path %path% --overwrite %overwrite%
```
```json title="Result"
{
"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"
}
```

8
docs/en/md/Dropbox/File-and-directory-management/_category_.json
View File

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