Skip to main content

Start Multipart body

Initializes writing data to the body in multipart format

Function StartMultipartBody(UseFile = True, Val View = "form-data") Export

ParameterCLI optionTypeRequiredDescription
UseFile-BooleanTrue > use a temporary file, False > form a body in memory
View-StringMultipart data type: form data, related

Returns: DataProcessorObject.OPI_HTTPClient - This processor object


tip

The AddMultipartFormDataFile and AddMultipartFormDataField methods are used for further body formation

caution

NOCLI: this method is not available in CLI version


1C:Enterprise/OneScript code example
    URL = "https://httpbin.org";
URL = URL + "/post";

Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data

Result = OPI_HTTPRequests.NewRequest()
.Initialize(URL)
.StartMultipartBody() // <---
.AddMultipartFormDataFile("file1", "pic.png", Image, "image/png")
.AddMultipartFormDataField("Field1", "Text")
.AddMultipartFormDataField("Field2", "10")
.ProcessRequest("POST")
.ReturnResponseAsJSONObject();
Result
{
"args": {},
"data": "",
"files": {
"file1": "..."
},
"form": {
"Field1": "Text",
"Field2": "10"
},
"headers": {
"Accept": "*/*",
"Accept-Charset": "utf-8",
"Accept-Encoding": "gzip",
"Content-Length": "2114372",
"Content-Type": "multipart/form-data; boundary=5e72ac80b8b046caabe050446d3ce734",
"Host": "httpbin.org",
"User-Agent": "1Script v$1.9.2.10",
"X-Amzn-Trace-Id": "Root=1-682cd6a3-47e4b39b749910d77683a89a"
},
"json": null,
"origin": "***",
"url": "https://httpbin.org/post"
}