1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-27 22:18:36 +02:00
Files
OpenIntegrations/docs/en/md/S3/Objects-management/Upload-full-object.mdx
Vitaly the Alpaca (bot) 347c900389 Main build (Jenkins)
2025-09-16 09:07:33 +03:00

105 lines
3.7 KiB
Plaintext
Vendored

---
sidebar_position: 2
description: Upload full object and other functions to work with S3 in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, S3]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Upload full object
Upload object with single request
`Function UploadFullObject(Val Name, Val Bucket, Val Entity, Val BasicData, Val Headers = Undefined, Val Directory = False) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | --name | String | ✔ | Name of the object in the bucket |
| Bucket | --bucket | String | ✔ | Name of the bucket to put the object |
| Entity | --data | String, BinaryData | ✔ | File path or binary data of the object |
| BasicData | --basic | Structure Of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
| Directory | --dir | Boolean | ✖ | True > Path style URL, False > Virtual hosted style URL |
Returns: Structure Of KeyAndValue - serialized JSON response from storage
<br/>
:::tip
Method at AWS documentation: [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
This is a service method. A `PutObject` method is intended for the common scenario of files uploading<br/>Using this method for large files may cause errors
Parameters with Binary data type can also accept file paths on disk and URLs
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
Name = "pictureSmall.jpg";
Entity = "https://hut.openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary Data
Directory = True; // Formation URL in path-style
Bucket = "opi-dirbucket3";
Result = OPI_S3.UploadFullObject(Name, Bucket, Entity, BasicData, , Directory);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint s3 UploadFullObject \
--name "pictureSmall.jpg" \
--bucket "opi-dirbucket3" \
--data "https://hut.openintegrations.dev/test_data/picture.jpg" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" \
--dir true
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint s3 UploadFullObject ^
--name "pictureSmall.jpg" ^
--bucket "opi-dirbucket3" ^
--data "https://hut.openintegrations.dev/test_data/picture.jpg" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" ^
--dir true
```
</TabItem>
</Tabs>
```json title="Result"
{
"status": 200,
"response": {},
"headers": {
"Accept-Ranges": "bytes",
"Date": "Mon, 15 Sep 2025 23:15:56 GMT",
"ETag": "\"9e0176f87f6565a22f78e0f9b39a4d78\"",
"Server": "MinIO",
"Strict-Transport-Security": "max-age=31536000; includeSubDomains",
"Vary": "Origin, Accept-Encoding",
"X-Amz-Id-2": "057275ee0636b36a8256f409a6ff665de46bfaa1f0d5faf2d1b4f312e55c34fa",
"X-Amz-Request-Id": "186597D097C43A5B",
"X-Content-Type-Options": "nosniff",
"X-XSS-Protection": "1; mode=block",
"Content-Length": "0",
"Content-Type": "text/plain; charset=utf-8"
}
}
```