JavaScript

Add a Path Substitution Parameter to a REST Request

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

var rest = new CkRest();

//  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.
var bTls = true;
var bAutoReconnect = true;
success = rest.Connect("example.com",443,bTls,bAutoReconnect);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

//  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.
var responseText = rest.FullRequestNoBody("GET","/users/{userId}/orders/{orderId}");
if (rest.LastMethodSuccess == false) {
    console.log(rest.LastErrorText);
    return;
}

console.log(responseText);