1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-05-29 23:17:45 +02:00
OpenIntegrations/docs/en/md/S3/Common-methods/Send-request-with-body.mdx

77 lines
2.3 KiB
Plaintext
Raw Normal View History

2024-11-14 17:27:44 +03:00
---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Send request with body
Send http request with body
2024-11-19 15:23:29 +03:00
`Function SendRequestWithBody(Val Method, Val BasicData, Val Body, Val ExpectedBinary = False, Val Headers = Undefined) Export`
2024-11-14 17:27:44 +03:00
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Method | --method | String | ✔ | HTTP method |
2024-12-29 17:57:09 +03:00
| BasicData | --basic | Structure Of KeyAndValue | ✔ | Basic request data (with full URL). See GetBasicDataStructure |
2024-11-14 17:27:44 +03:00
| Body | --body | String, BinaryData | ✔ | Binary data or file of request body data |
2024-11-19 15:23:29 +03:00
| ExpectedBinary | --binary | Boolean | ✖ | Disables an attempt to convert the response to JSON |
2024-11-14 17:27:44 +03:00
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
2024-12-29 17:57:09 +03:00
Returns: Structure Of KeyAndValue - serialized JSON response from storage
2024-11-14 17:27:44 +03:00
<br/>
:::tip
Parameters with Binary data type can also accept file paths on disk and URLs
:::
<br/>
2024-12-16 19:38:57 +03:00
2024-11-14 17:27:44 +03:00
```bsl title="1C:Enterprise/OneScript code example"
2024-11-15 10:05:19 +03:00
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
2024-11-14 17:27:44 +03:00
2024-11-15 10:05:19 +03:00
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
Method = "PUT";
Body = "C:\test_data\document.docx"; // URL, Path or Binary Data
Result = OPI_S3.SendRequestWithBody(Method, BasicData, Body);
2024-11-14 17:27:44 +03:00
```
2024-11-17 16:09:58 +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 SendRequestWithBody \
--method "PUT" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" \
--body "C:\test_data\document.docx"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: JSON data can also be passed as a path to a .json file
oint s3 SendRequestWithBody ^
--method "PUT" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}" ^
--body "C:\test_data\document.docx"
```
</TabItem>
</Tabs>
2024-11-14 17:27:44 +03:00