1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-31 22:05:13 +02:00
OpenIntegrations/docs/en/md/S3/Common-methods/Get-basic-data-structure.mdx
Vitaly the Alpaca (bot) f67675686d Main build (Jenkins)
2024-12-29 17:57:09 +03:00

74 lines
1.9 KiB
Plaintext

---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get basic data structure
Returns the basic data for request in structured form
`Function GetBasicDataStructure(Val URL, Val AccessKey, Val SecretKey, Val Region, Val Service = "s3") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | ✔ | URL: domain for common methods or full URL with parameters for direct request sending |
| AccessKey | --access | String | ✔ | Access key for authorization |
| SecretKey | --secret | String | ✔ | Secret key for authorization |
| Region | --region | String | ✔ | Service region |
| Service | --service | String | ✖ | Type of service, if different from s3 |
Returns: Structure Of KeyAndValue - Basic request data structure
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
Result = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint s3 GetBasicDataStructure \
--url "storage-155.s3hoster.by" \
--access "BRN5RKJE67YCVDZRRQVI" \
--secret "***" \
--region "BTC"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint s3 GetBasicDataStructure ^
--url "storage-155.s3hoster.by" ^
--access "BRN5RKJE67YCVDZRRQVI" ^
--secret "***" ^
--region "BTC"
```
</TabItem>
</Tabs>
```json title="Result"
{
"URL": "storage-155.s3hoster.by",
"AccessKey": "BRN5RKJE67YCVDZRRQVI",
"SecretKey": "***",
"Region": "BTC",
"Service": "s3"
}
```