2024-11-19 15:23:29 +03:00
---
2024-11-22 09:37:00 +03:00
sidebar_position: 8
2025-05-05 11:15:20 +03:00
description: Get 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
2025-05-05 09:49:19 +03:00
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, S3]
2024-11-19 15:23:29 +03:00
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get object
Gets the contents of the object from the bucket
2025-08-13 16:57:49 +03:00
`Function GetObject(Val Name, Val Bucket, Val BasicData, Val Version = "", Val Headers = Undefined, Val SavePath = "", Val Directory = False) Export`
2024-11-19 15:23:29 +03:00
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Name | --name | String | ✔ | Name of the object in the bucket |
| Bucket | --bucket | String | ✔ | Name of the bucket in which the object is stored |
2024-12-29 17:57:09 +03:00
| BasicData | --basic | Structure Of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
2024-11-19 15:23:29 +03:00
| Version | --ver | String | ✖ | Token for receiving a specific version of an object |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
| SavePath | --out | String | ✖ | Path to directly write a file to disk |
2025-09-01 14:51:24 +03:00
| Directory | --dir | Boolean | ✖ | True > Path style URL, False > Virtual hosted style URL |
2024-11-19 15:23:29 +03:00
2024-11-20 21:05:45 +03:00
Returns: BinaryData, String - object content or file path, if a save path is specified
2024-11-19 15:23:29 +03:00
<br/>
:::tip
2024-11-21 13:27:18 +03:00
Method at AWS documentation: [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
2024-11-21 14:55:35 +03:00
You can use the `ChunkSize` field in the basic data to specify the minimum file and chunk size for a chunked upload For example, `ChunkSize=X` means that all files larger than `X` (in bytes) will be downloaded in chunks, where one chunk will be of size `X`. Chunk upload is used for large files. Default `ChunkSize` - 20971520 bytes (20 MB)
2024-11-19 15:23:29 +03:00
:::
<br/>
2024-12-16 19:38:57 +03:00
2024-11-19 15:23:29 +03:00
```bsl title="1C:Enterprise/OneScript code example"
2025-06-29 14:35:33 +03:00
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
2024-11-19 15:23:29 +03:00
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
2025-09-01 14:51:24 +03:00
Name = "picture.jpg";
2024-11-19 15:23:29 +03:00
2025-09-01 14:51:24 +03:00
Directory = True; // Formation URL in path-style
Bucket = "opi-dirbucket3";
Result = OPI_S3.GetObject(Name, Bucket, BasicData, , , , Directory);
2024-11-19 15:23:29 +03:00
TempFile = GetTempFileName();
BasicData.Insert("ChunkSize", 200000);
Result = OPI_S3.GetObject(Name, Bucket, BasicData, , , TempFile);
```
2024-11-20 14:49:03 +03:00
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint s3 GetObject \
2024-11-22 15:16:03 +03:00
--name "bigfile.exe" \
--bucket "newbucket2" \
2025-09-16 09:07:33 +03:00
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3','ChunkSize':'200000'}"
2024-11-20 14:49:03 +03:00
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint s3 GetObject ^
2024-11-22 15:16:03 +03:00
--name "bigfile.exe" ^
--bucket "newbucket2" ^
2025-09-16 09:07:33 +03:00
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3','ChunkSize':'200000'}"
2024-11-20 14:49:03 +03:00
```
</TabItem>
</Tabs>
2024-11-19 15:23:29 +03:00
2024-11-22 15:16:03 +03:00
```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…
```