2024-11-18 21:03:13 +03:00
---
2024-11-22 09:37:00 +03:00
sidebar_position: 14
2025-05-05 11:15:20 +03:00
description: List objects 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-18 21:03:13 +03:00
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# List objects
Gets the list of objects in the selected bucket
2025-08-13 16:57:49 +03:00
`Function ListObjects(Val Bucket, Val BasicData, Val Prefix = "", Val PageToken = "", Val Headers = Undefined, Val Directory = False) Export`
2024-11-18 21:03:13 +03:00
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Bucket | --bucket | String | ✔ | Bucket name |
2024-12-29 17:57:09 +03:00
| BasicData | --basic | Structure Of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
2024-11-18 21:03:13 +03:00
| Prefix | --prefix | String | ✖ | Filtering by prefix, if necessary |
| PageToken | --ctoken | String | ✖ | Page token if pagination is used |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
2025-09-01 14:51:24 +03:00
| Directory | --dir | Boolean | ✖ | True > Path style URL, False > Virtual hosted style URL |
2024-11-18 21:03:13 +03:00
2024-12-29 17:57:09 +03:00
Returns: Structure Of KeyAndValue - serialized JSON response from storage
2024-11-18 21:03:13 +03:00
<br/>
:::tip
2024-11-21 13:27:18 +03:00
Method at AWS documentation: [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
2024-11-18 21:03:13 +03:00
:::
<br/>
2024-12-16 19:38:57 +03:00
2024-11-18 21:03:13 +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-18 21:03:13 +03:00
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
2025-09-01 14:51:24 +03:00
Directory = True; // Formation URL in path-style
Bucket = "opi-dirbucket3";
Result = OPI_S3.ListObjects(Bucket, BasicData, , , , Directory);
2024-11-18 21:03:13 +03:00
```
2024-11-20 14:49:03 +03:00
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
# JSON data can also be passed as a path to a .json file
oint s3 ListObjects \
--url "storage-155.s3hoster.by" \
--access "BRN5RKJE67YCVDZRRQVI" \
--secret "***" \
--region "BTC" \
--bucket "opi-gpbucket3" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: JSON data can also be passed as a path to a .json file
oint s3 ListObjects ^
--url "storage-155.s3hoster.by" ^
--access "BRN5RKJE67YCVDZRRQVI" ^
--secret "***" ^
--region "BTC" ^
--bucket "opi-gpbucket3" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
```
</TabItem>
</Tabs>
2024-11-18 21:03:13 +03:00
2024-11-22 15:16:03 +03:00
```json title="Result"
{
"status": 200,
"response": {
"ListBucketResult": {
2025-09-12 20:23:31 +03:00
"Name": "opi-dirbucket3",
2024-11-22 15:16:03 +03:00
"Prefix": {},
"KeyCount": "1",
"MaxKeys": "250",
"IsTruncated": "false",
"Contents": {
"Key": "picture.jpg",
2025-09-15 13:14:53 +03:00
"LastModified": "2025-09-15T07:02:56.359Z",
2024-11-22 15:16:03 +03:00
"ETag": "\"9e0176f87f6565a22f78e0f9b39a4d78\"",
"Size": "2114023",
"StorageClass": "STANDARD"
}
}
},
"headers": {
"Accept-Ranges": "bytes",
2025-09-15 13:14:53 +03:00
"Date": "Mon, 15 Sep 2025 07:04:34 GMT",
2024-11-22 15:16:03 +03:00
"Server": "MinIO",
"Strict-Transport-Security": "max-age=31536000; includeSubDomains",
2025-09-12 20:23:31 +03:00
"Vary": "Origin, Accept-Encoding",
2025-09-14 15:36:38 +03:00
"X-Amz-Id-2": "0757065d17b69556603743b9ea63f04bc7b9f349245bbff6b0ba901258e9c169",
2025-09-15 13:14:53 +03:00
"X-Amz-Request-Id": "186562CFDD98828F",
2024-11-22 15:16:03 +03:00
"X-Content-Type-Options": "nosniff",
2025-09-12 20:23:31 +03:00
"X-XSS-Protection": "1; mode=block",
"Content-Length": "452",
"Content-Type": "application/xml"
2024-11-22 15:16:03 +03:00
}
}
```