Stream a REST Response Body to a Destination

See more REST Examples

Demonstrates Rest.SetResponseBodyStream, which configures a Stream destination for response bodies received by the full-request convenience methods. The body is written to the stream only when the response status code matches the expected status.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

$rest = New-Object Chilkat.Rest
$bTls = $true
$bAutoReconnect = $true
$success = $rest.Connect("example.com",443,$bTls,$bAutoReconnect)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

#  The file paths are relative to the application's current working directory.  Absolute paths
#  may also be used.  Supply the paths appropriate to your own environment.

#  Configure a Stream destination for response bodies received by the full-request convenience
#  methods.  The body is written to the stream only when the response status code matches the 1st
#  argument.
$respStream = New-Object Chilkat.Stream
$respStream.SinkFile = "qa_output/response_body.dat"

#  The 2nd argument sets the stream character set from the response Content-Type charset for textual
#  responses.  The 3rd argument is the destination Stream.
$bAutoSetCharset = $true
$expectedStatus = 200
$success = $rest.SetResponseBodyStream($expectedStatus,$bAutoSetCharset,$respStream)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

#  The full-request call now streams the response body to the sink instead of returning it.
$responseText = $rest.FullRequestNoBody("GET","/api/largefile")
if ($rest.LastMethodSuccess -eq $false) {
    $($rest.LastErrorText)
    exit
}

$("Response streamed to file.  Status: " + $rest.ResponseStatusCode)