mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-04-15 11:56:36 +02:00
78 lines
2.3 KiB
Plaintext
78 lines
2.3 KiB
Plaintext
---
|
|
sidebar_position: 6
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# Head object
|
|
Receives information about the properties of the object in the baquette
|
|
|
|
|
|
|
|
`Function HeadObject(Val Name, Val Bucket, Val BasicData, Val Version = Undefined, Val Headers = Undefined) Export`
|
|
|
|
| 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 |
|
|
| BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
|
|
| Version | --ver | String | ✖ | Token for receiving a specific version of an object |
|
|
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
|
|
|
|
|
|
Returns: Structure of KeyAndValue - serialized JSON response from storage
|
|
|
|
<br/>
|
|
|
|
:::tip
|
|
Object metadata is contained in the headers
|
|
|
|
Method at AWS documentation: [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)
|
|
:::
|
|
<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 = "picture.jpg";
|
|
Bucket = "opi-gpbucket3";
|
|
|
|
Result = OPI_S3.HeadObject(Name, Bucket, BasicData);
|
|
```
|
|
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="bash" label="Bash" default>
|
|
```bash
|
|
# JSON data can also be passed as a path to a .json file
|
|
|
|
oint s3 HeadObject \
|
|
--name "picture.jpg" \
|
|
--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 HeadObject ^
|
|
--name "picture.jpg" ^
|
|
--bucket "opi-gpbucket3" ^
|
|
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
|
|
```
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
|