Documentation

Extensions Reference: Request
- Request
  - id
  - name
  - description
  - order
  - parent
  - url
  - urlBase
  - urlQuery
  - method
  - headers
  - httpBasicAuth
  - oauth1
  - oauth2
  - body
  - urlEncodedBody
  - multipartBody
  - jsonBody
  - timeout
  - followRedirects
  - redirectAuthorization
  - redirectMethod
  - sendCookies
  - storeCookies
  - getMethod
  - getUrl
  - getUrlBase
  - getUrlParameters
  - getUrlParametersNames
  - getUrlParameterByName
  - setUrlParameter
  - addUrlParameter
  - addRawUrlQuery
  - getHeaders
  - getHeadersNames
  - getHeaderByName
  - setHeader
  - addHeader
  - getHttpBasicAuth
  - getOAuth1
  - getOAuth2
  - getBody
  - getJsonBodyKeyPath
  - getUrlEncodedBody
  - getUrlEncodedBodyKeys
  - getUrlEncodedBodyKey
  - getMultipartBody
  - getLastExchange
  - getAllExchanges

Extensions Reference: Request¶

API Reference
Request

Request

Request¶

The Request object represents a Paw request as the ones you can see in the left requests panel.

If you’re looking for a way to run an HTTP request during the execution of your extension code, NetworkHTTPRequest may be what you need.

id

id¶

The request unique identifier, an UUID generated by Paw for each request (UUID) (Read-only).

function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.id; // e.g. "6B5C65E8-CBF4-4FF1-A4BA-3BCF8DA538C1"
}

name

name¶

The request name as it is shown in the requests view. (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.name; // e.g. "My API"
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.name = "Hello World";
}

description

description¶

The request description as shown in the requests view. (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.description; // e.g. "My API Description..."
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        // Request description
        var description = 'This API is awesome!';

        // Create a request
        var request = context.createRequest('My Imported Request', 'POST', 'https://api.domain.com/path', description, options.order);

        // or, alternatively:
        //request.description = description;

        // insert into proper group (if drag & dropped in request list)
        if (options.parent !== undefined) {
                options.parent.insertChild(req, options.order);
        }

        return true; // success
}

order

order¶

The order of the request in its parent RequestGroup or as a root item (orders starts at 0). (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.order; // e.g. 42
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request1 = context.createRequest();
        var request2 = context.createRequest();
        request2.order = 0; // request2 will come first
}

parent

parent¶

The parent RequestGroup if any, otherwise null. (Read-only).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var getSiblings = function(context, requext) {
                var parentGroup = request.parent;
                var siblings;
                if (typeof parentGroup === 'object') {
                        console.log("Parent: " + parentGroup.name);
                        siblings = parentGroup.getChildRequests();
                }
                else {
                        console.log("Request is at root");
                        siblings = context.getRootRequests();
                }
                console.log("Has " + (siblings.length - 1) + " siblings (requests)");
                return siblings;
        }

        // Access siblings
        return getSiblings(context, context.getCurrentRequest()).length.toString();
}

url

url¶

The URL of the request. (Writable property only for Importers).

A string is returned. The getter method getUrl() is also available and allows access to the URL as a DynamicString.

// Read use (Dynamic Value, Code Generator...): get the URL as a string
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.url; // equivalent to `request.getUrl(false)`
}

Mutation is only available in Importer extensions.

Either a string or DynamicString can be assigned.

// Write use (Importers): set the URL as a string
function import(context, items, options) {
        var request = context.createRequest();
        request.url = "http://api.domain.io/v1/path/"
}

// Write use (Importers): set the URL as a DynamicString
function import(context, items, options) {
        var request = context.createRequest();
        var dynamicValue = DynamicValue('com.luckymarmot.HashDynamicValue', {
                'input':'MY_TOKEN'
        });
        request.url = DynamicString("http://api.domain.io/v1/path/?hash=", dynamicValue);
}

urlBase

urlBase¶

The URL of the request excluding query params (everything up to the first ?). (Read-only)

A string is returned. The getter method getUrlBase() is also available and allows access to the URL as a DynamicString.

function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.urlBase; // equivalent to `request.getUrlBase(false)`
}

urlQuery

urlQuery¶

The query part of the URL of the request (everything after the first ?). Returns an empty string if there’s no query string. (Read-only)

A string is returned.

function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.urlQuery;
}

method

method¶

The method of the request. (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.method; // e.g. "POST"
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.method = "PATCH";
}

headers

headers¶

Returns an object (dictionary) pairing the request’s headers values to their names. Headers values are returned as plain strings. The getter method getHeaders() is also available and allows access to the headers values as DynamicString.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...): get headers values as a strings
function evaluate(context) {
        var request = context.getCurrentRequest();

        // equivalent to `request.getHeaders(false)`
        var headers = request.headers;

        // enumerate headers
        for (var headerName in headers) {
        var headerValue = headers[headerName]; // string
                console.log("" + headerName + ": " + headerValue);
        }

        // all headers names, comma separated (e.g. "Content-Type,Accept")
        return Object.keys(headers).join(',');
}

Mutation is only available in Importer extensions.

Assign an object (dictionary) pairing header names to header values as either strings or DynamicString. Existing headers will be erased.

// Write use (Importers): set headers as strings
function import(context, items, options) {
        var request = context.createRequest();

        request.headers = {
                Content-Type: 'application/json',
                Authorization: 'MY_TOKEN',
        };
}

// Write use (Importers): set headers as DynamicStrings and strings
function import(context, items, options) {
        var request = context.createRequest();

        request.headers = {
                Content-Type: 'application/json', // string
                Authorization: DynamicString('Token=', DynamicValue('com.luckymarmot.NonceDynamicValue')), // DynamicString
        };
}

httpBasicAuth

httpBasicAuth¶

Returns the request HTTP Basic Auth configuration, if any, as an object (dictionary) with the "username" and "password" keys containing strings. The getter method getHttpBasicAuth() is also available and allows access to the HTTP Basic Auth parameters as DynamicString.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...):
// get the request HTTP Basic Auth parameters as strings
function evaluate(context) {
        var request = context.getCurrentRequest();

        // get configuration as an object: string -> string
        // equivalent to `request.getHttpBasicAuth(false)`
        var basicAuth = request.httpBasicAuth;

        var username = basicAuth["username"]; // string
        var password = basicAuth["password"]; // string

        return "" + username + "/" + password;
}

Mutation is only available in Importer extensions.

Assign HTTP Basic Auth "username" and "password" parameters through an object (dictionary). Values can be either strings or DynamicString. The object fields username, password are required.

// Write use (Importers):
// set the request HTTP Basic Auth parameters as strings
function import(context, items, options) {
        var request = context.createRequest();

        request.httpBasicAuth = {
                "username":"paw",
                "password":"pass"
        };
}

// Write use (Importers):
// set the request HTTP Basic Auth parameters as DynamicStrings
function import(context, items, options) {
        var request = context.createRequest();

        // create a DynamicValue
        var dynamicValue = DynamicValue('com.luckymarmot.HashDynamicValue', {
                'input':'Something to hash...'
        });

        // set basic auth parameters as DynamicStrings
        request.httpBasicAuth = {
                "username":DynamicString("paw"),
                "password":DynamicString(dynamicValue)
        };
}

oauth1

oauth1¶

The request OAuth 1 configuration, if any, as an object (dictionary) containing strings. The getter method getOAuth1() is also available and allows access to the OAuth 1 parameters as DynamicStrings.

(Writable property only for Importers).

// Get OAuth 1 conf values
function evaluate(context) {
        var request = context.getCurrentRequest();

        // get configuration as an object: string -> string
        var oauth1 = request.oauth1;

        var consumerKey = oauth1["oauth_consumer_key"];
        var consumerSecret = oauth1["oauth_consumer_secret"];
        var token = oauth1["oauth_token"];
        var tokenSecret = oauth1["oauth_token_secret"];
        var nonce = oauth1["oauth_nonce"];
        var timestamp = oauth1["oauth_timestamp"];
        var callback = oauth1["oauth_callback"];
        var signature = oauth1["oauth_signature"];
        var signatureMethod = oauth1["oauth_signature_method"]; // either "HMAC-SHA1" or
        "PLAINTEXT"
        var version = oauth1["oauth_version"]; // always "1.0"
        var additionalParameters = oauth1["oauth_additional_parameters"];

        return "" + consumerKey + "/" + token;
}

Mutation is only available in Importer extensions.

Assign the request OAuth 1 parameters through an object (dictionary). Values can be either strings or DynamicStrings. Here are the possible object fields:

oauth_consumer_key: Required Consumer key (app credential).
oauth_consumer_secret: Required Consumer secret (app credential).
oauth_token: Required Token value (user credential).
oauth_token_secret: Required Token secret (user credential).
oauth_nonce: Optional, don’t include this if you’re not sure The nonce to use in the OAuth signature. Defaults to a randomly generated nonce.
oauth_timestamp: Optional, don’t include this if you’re not sure The timestamp of the request to use in the signature. Defaults to the current UNIX timestamp
oauth_callback: Optional Defaults to an empty string.
oauth_signature_method: Optional Defaults to "HMAC-SHA1".
oauth_additional_parameters: Optional Defaults to an empty string.

// Write use (Importers):
// set the request OAuth 1 parameters as strings
function import(context, items, options) {
        var request = context.createRequest();

        request.oauth1 = {
                oauth_consumer_key: 'CONSUMER_KEY', // required
                oauth_consumer_secret: 'CONSUMER_SECRET', // required
                oauth_token: 'TOKEN', // required
                oauth_token_secret: 'TOKEN_SECRET', // required
                oauth_signature_method: 'HMAC-SHA1' // either 'HMAC-SHA1' or 'PLAINTEXT'
        };
}

oauth2

oauth2¶

The request OAuth 2 (see RFC 6749) configuration, if any, as an object (dictionary) containing strings. The getter method getOAuth2() is also available and allows access to the OAuth 2 parameters as DynamicStrings.

(Writable property only for Importers).

// Get OAuth 2 conf values
function evaluate(context) {
        var request = context.getCurrentRequest();

        // get configuration as an object: string -> string
        var oauth2 = request.oauth2;

        // client credentials
        var clientId = oauth2["client_id"];
        var clientSecret = oauth2["client_secret"];

        // authorization, access token, redirect URIs
        var authorizationUri = oauth2["authorization_uri"];
        var accessTokenUri = oauth2["access_token_uri"];
        var redirectUri = oauth2["redirect_uri"];

        // scope
        var scope = oauth2["scope"];

        // state
        var state = oauth2["state"];

        // token (and its prefix)
        var token = oauth2["token"];
        var tokenPrefix = oauth2["token_prefix"]; // default: "Bearer "

        // grant type
        var grantType = oauth2["grant_type"]; // always "authorization_code"

        return clientId;
}

Mutation is only available in Importer extensions.

Assign the request OAuth 2 parameters through an object (dictionary). Values can be either strings or DynamicStrings. Here are the possible object fields:

client_id: Required Client key.
client_secret: Required Client secret.
authorization_uri: Required The URL of the authorization page.
access_token_uri: Required The URL to use to get an access token from the temporary code.
redirect_uri: Required The URL to where the client will be redirected after authorization.
grant_type: Optional Defaults to "authorization_code" (if set, should always be the default value).
scope: Optional Optional The authorization scope. Defaults to an empty string.
state: Optional, don’t include this if you’re not sure In most cases you want to omit this field. Defaults to a randomly generated value.
token: Optional The OAuth 2 token to send, in most cases you want to leave this value empty and let the client visually gets the authorization. Defaults to an empty string.
token_prefix: Optional The string that will prefix the token (e.g. "Bearer " is the prefix in the header Bearer TOKEN_STRING). Defaults to "Bearer ".

// Write use (Importers):
// set the request OAuth 2 parameters as strings
function import(context, items, options) {
        var request = context.createRequest();

        request.oauth2 = {
                ent_id: 'CLIENT_ID', // required
                client_secret: 'CLIENT_SECRET', // required
                authorization_uri: 'AUTHORIZATION_URI', // required
                access_token_uri: 'ACCESS_TOKEN_URI', // required
                redirect_uri: 'REDIRECT_URI', // required
                scope: 'SCOPES',
                token: 'TOKEN', // optional, can be generated via the app
                token_prefix: 'Bearer ', // default 'Bearer '
                grant_clitype: 'authorization_code' // always set to 'authorization_code'
        };
}

body

body¶

The body of the request, A string is returned. The getter method getBody( is also available and allows access to the body as a DynamicString.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...): get the request body as a string
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.body; // equivalent to `request.getBody(false)`
}

Mutation is only available in Importer extensions.

Either a string or DynamicString can be assigned.

// Write use (Importers): set the body as a string
function import(context, items, options) {
        var request = context.createRequest();
        request.body = 'REQUEST BODY CONTENT'
}

// Write use (Importers): set the body as a DynamicString
function import(context, items, options) {
        var request = context.createRequest();
        var dynamicValue = DynamicValue('com.luckymarmot.HashDynamicValue', {
                input:'REQUEST BODY CONTENT (to hash)'
        });
        request.body = DynamicString("BODY CONTENT,hash=", dynamicValue);
}

urlEncodedBody

urlEncodedBody¶

Returns an object (dictionary) of the request’s application/x-www-form-urlencoded body parameters. All values are returned as strings. The getter method getUrlEncodedBody() is also available and allows access to the values as DynamicStrings.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...):
// form url-encoded body parameters as a strings
function evaluate(context) {
        var request = context.getCurrentRequest();

        // equivalent to `request.getUrlEncodedBody(false)`, e.g.
        // {
        //   "name":"Paw",
        //   "type":"app"
        // }
        var bodyParameters = request.urlEncodedBody;

        // enumerate parameters
        for (var key in bodyParameters) {
                var value = bodyParameters[key]; // string
                console.log("" + key + "=" + value);
        }

        // return parameters keys
        return Object.keys(bodyParameters).join(',');
}

Mutation is only available in Importer extensions.

Assign an object (dictionary) containing the request body as application/x-www-form-urlencoded body parameters. Keys must be strings, value can either be strings or DynamicStrings. Existing body will be erased.

// Write use (Importers): set body values as strings
function import(context, items, options) {
        var request = context.createRequest();

        request.urlEncodedBody = {
                name: 'Paw',
                type: 'app'
        };
}

// Write use (Importers): set body values as either DynamicStrings or strings
function import(context, items, options) {
  var request = context.createRequest();

  request.urlEncodedBody = {
        name: 'Paw', // string
        // DynamicString
        type: DynamicString("Random=", DynamicValue('com.luckymarmot.NonceDynamicValue')),
  };
}

multipartBody

multipartBody¶

Returns an object (dictionary) of the request’s multipart/form-data body parameters. All values are returned as strings. The getter method getMultipartBody() is also available and allows access to the values as DynamicStrings.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...):
// multipart body parameters as a strings
function evaluate(context) {
        var request = context.getCurrentRequest();

        // equivalent to `request.getMultipartBody(false)`, e.g.
        // {
        //   "name":"Paw",
        //   "type":"app"
        // }
        var multipartBody = request.multipartBody;

        // enumerate body multipart parameters
        for (var key in multipartBody) {
                var value = multipartBody[value]; // string
                console.log("" + key + "=" + value);
        }

        // return parameters keys
        return Object.keys(multipartBody).join(',');
}

Mutation is only available in Importer extensions.

Assign an object (dictionary) containing the request body as multipart/form-data body parameters. Keys must be strings, value can either be strings or DynamicStrings. Existing body will be erased.

// Write use (Importers): set body values as strings
function import(context, items, options) {
        var request = context.createRequest();

        request.multipartBody = {
                name: 'Paw',
                type: 'app'
        };
}

// Write use (Importers): set body values as either DynamicStrings or strings
function import(context, items, options) {
  var request = context.createRequest();

  request.multipartBody = {
        name: 'Paw', // string
        // DynamicString
        type: DynamicString("Random=", DynamicValue('com.luckymarmot.NonceDynamicValue')),
  };
}

jsonBody

jsonBody¶

The request body as an object (dictionary or array), when it uses the JSON body format. (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...):
function evaluate(context) {
        var request = context.getCurrentRequest();

        // e.g.
        // {
        //   "name":"Paw",
        //   "type":"app",
        //   "ratings":5,
        //   "enabled":true
        // }
        var jsonBody = request.jsonBody;

        // parse some body keys...
        return jsonBody["name"]; // "Paw"
}

Mutation is only available in Importer extensions.

Assign an object to the request JSON body.

// Write use (Importers):
function import(context, items, options) {
        var request = context.createRequest();

        request.jsonBody = {
                "name":"Paw",
                "type":"app",
                "ratings":5,
                "enabled":true
        };
}

timeout

timeout¶

The request timeout in milliseconds. (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.timeout; // e.g. 3000 for 3 seconds
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.timeout = 10000; // for 10 seconds
}

followRedirects

followRedirects¶

Boolean value, whether the request should follow redirections when run. (Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.followRedirects; // true if follows redirections
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.followRedirects = true; // follows redirections
}

redirectAuthorization

redirectAuthorization¶

Boolean value, whether the Authorization header should be forwarded after redirections.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.redirectAuthorization; // true if forwards Authorization header is forwarded
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.redirectAuthorization = true; // forwards Authorization header
}

redirectMethod

redirectMethod¶

Boolean value, whether the request should be sent using its original HTTP method (verb) after a redirection, or should use GET for requests after a redirection.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.redirectMethod; // true, next requests will use original method
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.redirectMethod = false; // next requests will all use GET
}

sendCookies

sendCookies¶

Boolean value, whether cookies stored in the current cookie jar will be sent (if match host, path, secure, etc.). If false no cookies are sent (unless specified in a manually set Cookie header).

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.sendCookies; // true if cookies will be added
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.sendCookies = false; // do not send cookies automatically
}

storeCookies

storeCookies¶

Boolean value, whether cookies sent by the server via Set-Cookie headers should be stored in the current cookie jar to be sent in subsequent requests.

(Writable property only for Importers).

// Read use (Dynamic Value, Code Generator...)
function evaluate(context) {
        var request = context.getCurrentRequest();
        return request.storeCookies; // if true, cookies will be stored
}

Mutation is only available in Importer extensions.

// Write use (Importers)
function import(context, items, options) {
        var request = context.createRequest();
        request.storeCookies = false; // cookies received won't be stored
}

getMethod

getMethod¶

Argument: returnDynamicString: boolean: None
if true will return teh value as a DynamicString

Returns: None: DynamicString || string

If returnDynamicString is true: returns the method as a DynamicString.
Otherwise, returns the method as a string (equivalent to accessing the method property).

getUrl

getUrl¶

Argument: returnDynamicString: boolean: None
if true will return the value as a DynamicString

Returns: None: DynamicString || string

If returnDynamicString is true: returns the value of the URL as a DynamicString.
Otherwise, returns the value for the URL as a string (equivalent to accessing the url property).

// Get the URL as a DynamicString
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get the URL as a DynamicString
  var urlDynamicString = request.getUrl(true);

  // enumerate on DynamicString's components
  for (var componentIdx in urlDynamicString.components) {
        // component, either a string or a DynamicValue
        var component = urlDynamicString.components[componentIdx];

        if (typeof component == 'string') { // string
          console.log("String: " + component);
        }
        else { // DynamicValue
          console.log("DynamicValue: " + component.toString());
        }
  }

  return urlDynamicString.length;
}

getUrlBase

getUrlBase¶

Argument: returnDynamicString: boolean: None
if true will return the value as a DynamicString

Returns: None: DynamicString || string

If returnDynamicString is true: returns the value of the URL without URL parameters as a DynamicString.
Otherwise, returns the value of the URL without URL parameters as a string

getUrlParameters

getUrlParameters¶

Argument: returnDynamicString: boolean: None
if true will return the values as DynamicStrings

Returns: None: Object

Returns an object (dictionary) pairing the parameter values to their names.

If returnDynamicString is true: values are returned as DynamicStrings.
Otherwise, parameter values are returned as plain strings.

getUrlParametersNames

getUrlParametersNames¶

Returns: None: Array
Returns all parameter names as an array of strings.

getUrlParameterByName

getUrlParameterByName¶

Argument: parameterName: string: None
The parameter name requested

Argument: returnDynamicString: boolean: None
if true will return the value as a DynamicString

Returns: None: DynamicString || string

Returns the value of the given parameter name or null.

If returnDynamicString is true: the parameter value is returned as a DynamicString.
Otherwise, the value is returned as a plain string.

setUrlParameter

setUrlParameter¶

Argument: parameterName: string: None
The parameter name requested

Argument: parameterValue: string || DynamicString: None
The value to set

Sets the given value for the parameter.

addUrlParameter

addUrlParameter¶

Argument: parameterName: string: None
The parameter name to add

Argument: parameterValue: string || DynamicString: None
The value to add

Adds the URL parameter with the given name and value.

addRawUrlQuery

addRawUrlQuery¶

Argument: queryString: string: None
The raw query string to add.

Adds a new raw query string that will be appended to the request URL after the ? and, if any, after other existing URL parameters. Raw query strings won’t be URL encoded.

getHeaders

getHeaders¶

Argument: returnDynamicString: boolean: None
if true will return header values as DynamicStrings

Returns: None: Object
Returns an object (dictionary) pairing the request’s headers values to their names.

If returnDynamicString is true: headers values are returned as DynamicStrings.
Otherwise, header values are returned as plain strings (equivalent to accessing the headers property).

// Get headers values as DynamicStrings
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get headers as an object: string -> DynamicString
  var headers = request.getHeaders(true);

  // enumerate headers
  for (var headerName in headers) { // headerName is a string
        var headerValue = headers[headerName]; // DynamicString
        console.log("" + headerName + " -> " + headerValue.toString());
  }

  // all headers names, comma separated (e.g. "Content-Type,Accept")
  return Object.keys(headers).join(',');
}

getHeadersNames

getHeadersNames¶

Returns: None: Array
Returns all header names as an array of strings.

getHeaderByName

getHeaderByName¶

Argument: headerName: string: None
The header name requested

Argument: returnDynamicString: boolean: None
if true will return the value as a DynamicString

Returns: None: DynamicString || string

Returns the value of the given header name or null.

If returnDynamicString is true: the header value is returned as a DynamicString.
Otherwise, the value is returned as plain strings.

// Get some header value as a string
function evaluate(context) {
  var request = context.getCurrentRequest();

  // access the "Content-Type" header as a string
  var contentType = request.getHeaderByName("Content-Type");

  return contentType;
}

function evaluate(context) {
  var request = context.getCurrentRequest();

  // access the "Content-Type" header as a DynamicString
  var contentType = request.getHeaderByName("Content-Type", true);

  return contentType.toString();
}

setHeader

setHeader¶

Argument: headerName: string: None
The header name requested

Argument: headerValue: string || DynamicString: None
The value to set

Sets the given value for the header.

// Set a header as a string
function evaluate(context) {
  var request = context.getCurrentRequest();

  // Set the "Content-Type" header
  request.setHeader("Content-Type", "application/json");
}

// Set a header as a DynamicString
function evaluate(context) {
  var request = context.getCurrentRequest();

  var dynamicValue = DynamicValue('com.luckymarmot.HashDynamicValue', {
        'input':'MY_STRING_TO_HASH'
  });

  // Set a custom "X-Signature" header
  request.setHeader("X-Signature", DynamicString(dynamicValue));
}

addHeader

addHeader¶

Argument: headerName: string: None
The header name to add

Argument: headerValue: string || DynamicString: None
The value to add

Adds the header with the given name and value.

getHttpBasicAuth

getHttpBasicAuth¶

Argument: returnDynamicString: boolean: None
if true will return values are DynamicStrings

Returns: None: Object
Returns the request HTTP Basic Auth configuration, if any, as an object (dictionary) with the "username" and "password" keys.

If returnDynamicString is true: values are returned as DynamicStrings.
Otherwise, values are returned as plain strings (equivalent to accessing the HttpBasicAuth property).

// Get HTTP Basic Auth conf values as DynamicStrings
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get configuration as an object: string -> DynamicString
  var basicAuth = request.getHttpBasicAuth(true);

  var username = basicAuth["username"]; // DynamicString
  var password = basicAuth["password"]; // DynamicString

  return "" + username.toString() + "/" + password.toString();
}

getOAuth1

getOAuth1¶

Argument: returnDynamicString: boolean: None
if true will return values are DynamicStrings

Returns: None: Object
Returns OAuth 1 configuration, if any, as an object (dictionary).

If returnDynamicString is true: values are returned as DynamicStrings.
Otherwise, values are returned as plain strings (equivalent to accessing the oauth1 property).

See the oauth1 property for more details about the fields.

// Get OAuth 1 conf values as DynamicStrings
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get configuration as an object: string -> DynamicString
  var oauth1 = request.getOAuth1(true);

  var consumerKey = oauth1["oauth_consumer_key"]; // DynamicString
  var consumerSecret = oauth1["oauth_consumer_secret"]; // DynamicString
  var token = oauth1["oauth_token"]; // DynamicString
  var tokenSecret = oauth1["oauth_token_secret"]; // DynamicString
  var nonce = oauth1["oauth_nonce"]; // DynamicString
  var timestamp = oauth1["oauth_timestamp"]; // DynamicString
  var callback = oauth1["oauth_callback"]; // DynamicString
  var signature = oauth1["oauth_signature"]; // DynamicString
  var signatureMethod = oauth1["oauth_signature_method"]; // string (either "HMAC-SHA1" or
  "PLAINTEXT")
  var version = oauth1["oauth_version"]; // string (always "1.0")
  var additionalParameters = oauth1["oauth_additional_parameters"]; // DynamicString


  return "" + consumerKey.toString() + "/" + token.toString();
}

getOAuth2

getOAuth2¶

Argument: returnDynamicString: boolean: None
if true will return values are DynamicStrings

Returns: None: Object
Returns the request OAuth 2 (see RFC 6749) configuration, if any, as an object (dictionary).

If returnDynamicString is true: values are returned as DynamicStrings.
Otherwise, values are returned as plain strings (equivalent to accessing the oauth2 property).

See the oauth2 property for more details about the fields.

// Get OAuth 2 conf values as DynamicStrings
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get configuration as an object: string -> DynamicString
  var oauth2 = request.getOAuth2(true);

  // client credentials
  var clientId = oauth2["client_id"]; // DynamicString
  var clientSecret = oauth2["client_secret"]; // DynamicString

  // authorization, access token, redirect URIs
  var authorizationUri = oauth2["authorization_uri"]; // DynamicString
  var accessTokenUri = oauth2["access_token_uri"]; // DynamicString
  var redirectUri = oauth2["redirect_uri"]; // DynamicString

  // scope
  var scope = oauth2["scope"]; // DynamicString

  // state
  var state = oauth2["state"]; // DynamicString

  // token (and its prefix)
  var token = oauth2["token"]; // DynamicString
  var tokenPrefix = oauth2["token_prefix"]; // DynamicString (default: "Bearer ")

  // grant type
  var grantType = oauth2["grant_type"]; // string (always "authorization_code")

  return clientId;
}

getBody

getBody¶

Argument: returnDynamicString: boolean: None
if true will return as a DynamicString

Returns: None: DynamicString || String
Returns the request body.

If returnDynamicString is true: a DynamicStrings is returned.
Otherwise, a plain strings is returned (equivalent to accessing the body property).

// Get the body as a DynamicString
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get the body as a DynamicString
  var bodyDynamicString = request.getBody(true);

  // returns the first component of the dynamic string
  return bodyDynamicString.getComponentAtIndex(0);
}

getJsonBodyKeyPath

getJsonBodyKeyPath¶

Argument: keyPath: string: None
the filtering keypath

Returns: None: string
Returns part of the JSON body according to the keypath.

getUrlEncodedBody

getUrlEncodedBody¶

Argument: returnDynamicString: boolean: None
if true will return values are DynamicStrings

Returns: None: Object
Returns an object (dictionary) of the request’s application/x-www-form-urlencoded body parameters.

If returnDynamicString is true: values are returned as DynamicStrings.
Otherwise, values are returned as plain strings (equivalent to accessing the urlEncodedBody property).

// Get the form url-encoded body parameters as a DynamicStrings
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get url encoded params as an object: string -> DynamicString
  var bodyParameters = request.getUrlEncodedBody(true);

  // enumerate parameters
  for (var key in bodyParameters) {
        var value = bodyParameters[value]; // DynamicString
        console.log("" + key + "=" + value.toString());
  }

  // return parameters keys
  return Object.keys(bodyParameters).join(',');
}

getUrlEncodedBodyKeys

getUrlEncodedBodyKeys¶

Returns: None: Array
Returns all the keys as an array of strings.

getUrlEncodedBodyKey

getUrlEncodedBodyKey¶

Argument: key: string: None
the requested key

Returns: None: string
Returns the value of the requested key as a plain string.

getMultipartBody

getMultipartBody¶

Argument: returnDynamicString: boolean: None
if true will return values are DynamicStrings

Returns: None: Object
Returns an object (dictionary) of the request’s multipart/form-data body parameters.

If returnDynamicString is true: values are returned as DynamicStrings.
Otherwise, values are returned as plain strings (equivalent to accessing the multipartBody property).

// Get the multipart body parameters as a DynamicStrings
function evaluate(context) {
  var request = context.getCurrentRequest();

  // get multipart params as an object: string -> DynamicString
  var multipartBody = request.getUrlEncodedBody(true);

  // enumerate parameters
  for (var key in multipartBody) {
        var value = multipartBody[value]; // DynamicString
        console.log("" + key + "=" + value.toString());
  }

  // return multipartBody keys
  return Object.keys(bodyParameters).join(',');
}

getLastExchange

getLastExchange¶

Returns: None: HTTPExchange
Returns the latest HTTPExchange for this request.

getAllExchanges

getAllExchanges¶

Returns: None: Array
Returns all exchange history for the given request as an array of HTTPExchange objects.