Sample code for 30+ languages & platforms
PowerShell

Add a Path Substitution Parameter to a REST Request

See more REST Examples

Demonstrates Rest.AddPathParam, which adds or replaces a path-substitution parameter. Before a request is sent, each occurrence of the name in the URI path is replaced with its value.

Background. Path parameters keep a URI path template readable—placeholders such as {userId} are substituted with concrete values just before the request is sent.

Chilkat PowerShell Downloads

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

$success = $false

$rest = New-Object Chilkat.Rest

#  Connect to the REST server.  The 3rd argument enables TLS (use $true for HTTPS on port 443),
#  and the 4th enables automatic reconnection if the connection is dropped between requests.
$bTls = $true
$bAutoReconnect = $true
$success = $rest.Connect("example.com",443,$bTls,$bAutoReconnect)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

#  Add path-substitution parameters.  Before a request is sent, each occurrence of the name in the
#  URI path is replaced with the value.  This keeps the path template readable.
$rest.AddPathParam("{userId}","12345")
$rest.AddPathParam("{orderId}","98765")

#  The placeholders in the path are replaced before the request is sent.
$responseText = $rest.FullRequestNoBody("GET","/users/{userId}/orders/{orderId}")
if ($rest.LastMethodSuccess -eq $false) {
    $($rest.LastErrorText)
    exit
}

$($responseText)