Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Adds a new parameter to request body.

RestRequest myRestRequest.AddParameter(name: string, value: object)

Adds a new parameter to request body.

RestRequest myRestRequest.AddParameter(name: string, value: object, type: ( "Cookie" | "GetOrPost" | "UrlSegment" | "HttpHeader" | "RequestBody" | "QueryString" | "QueryStringWithoutEncode" ))

Arguments

string name
Name of parameter
object value
Value of parameter
( "Cookie" | "GetOrPost" | "UrlSegment" | "HttpHeader" | "RequestBody" | "QueryString" | "QueryStringWithoutEncode" ) type
Type of parameter. Optional.

Remarks

Name and value arguments are required.

Type parameter is optional. If not specified default value is "GetOrPost".

Type parameter can be one of following;

GetOrPost

Cookie

HttpHeader

RequestBody

QueryString

Example

Code Block
languagets
var client = $Rest.Create('http://targetserver');
var request = client.Request();

request.AddParameter('x', 1);
request.AddParameter('y', {
  z : 3
});

// request body as
// {
//    "x" : 1,
//    "y" : {
//        "z" : 3
//    }
// }

var response = request.ExecuteJson();