Request¶

Creates a new RestRequest instance.

myRestClient.Request():RestRequest (RestRequest)

Creates a new RestRequest instance with the specified resource.

myRestClient.Request(resource: string):RestRequest (RestRequest)

Creates a new RestRequest instance with the specified resource and body.

myRestClient.Request(resource: string, body: ( string | object | Xml )):RestRequest (Xml, RestRequest)

Parameters¶

string resource
    The resource to request.

( string | object | Xml ) body
    The request body.

Returns¶

A new RestRequest instance. A new RestRequest instance. A new RestRequest instance.

Remarks¶

The body argument is optional. If specified, the request method is automatically set to POST; otherwise, it defaults to GET.

XML-type bodies are automatically detected if the body is specified as an Xml object or a string that starts with "<" and ends with ">" characters.

Create a request with a JSON body¶

1
2
3
4
5
6
7
8
9

var client = $Rest.Create('http://targetserver/');

var request = client.Request("file/{id}", {
    field : 'value'
});

request.AddUrlParameter('id',123456);

var result = request.ExecuteJson();

Create a request with an XML body¶

1
2
3
4
5
6
7

var client = $Rest.Create('http://targetserver/');

var request = client.Request('file/{id}','<root><field>value</field></root>');

request.AddUrlParameter('id',123456);

var result = request.ExecuteXml();

See Also¶

• RestRequest
• Xml