Documentation

Use values from responses

Use values from responses¶

Dynamic Values
Use values from responses

For general information about dynamic values and instructions on how to insert them in Paw see the introduction to dynamic values.

Reuse values from previous responses in a very declarative way.

Response Parsed Body

Response Parsed Body¶

../../_images/ResponseBodyPathDynamicValue.png

Extract a field from a response. It will parse the latest response of the selected request, and return the value (or serialized subtree) for the given key-path.

Example¶

A login API returns an auth token in the body, in a login field. Subsequent requests may use this dynamic value to point to the login request’s response, to the login field.

Format for Key Path extraction¶

To access nested levels use a dot separator. Use numbers to access elements in a list. As you start typing Paw will suggest autocomplete options for you.

Get nested dictionary keys (e.g. user.user_id)
Get nested array items (e.g. users.0 or user[0])
Get all items of an array (e.g. users.*.user_id)

com.luckymarmot.ResponseBodyPathDynamicValue

Argument: request: string: (current request)

The UUID of the request to inspect the latest response from.

(current request)

Argument: keyPath: DynamicString: None
The body path to extract.

Argument: format: number: ``0`` (automatic)

The response format to use for parsing (0: automatic, 1: JSON, 2: XML, 3: Form URL-Encoded).

0 (automatic)

function evaluate(context){
    var requestUuid = context.getCurrentRequest().id;
    var dv = new DynamicValue('com.luckymarmot.ResponseBodyPathDynamicValue', {
        request: requestUuid,
        keyPath: 'array[0].key.path' /* any dict key or array index */,
        format: 0 /* 0 = Automatic */
    });
    return dv.getEvaluatedString();
};

Response Raw Body

Response Raw Body¶

Returns the raw body of the reasons encoded using the Content-Type header in the respond.

com.luckymarmot.ResponseBodyLengthDynamicValue

Argument: request: string: (current request)

The UUID of the request to inspect the latest response from.

(current request)

function evaluate(context){
    var requestUuid = context.getCurrentRequest().id;
    var dv = new DynamicValue('com.luckymarmot.ResponseRawBodyDynamicValue', {
        request: requestUuid
    });
    return dv.getEvaluatedString();
};

Response Body Length

Response Body Length¶

Returns the raw text body of a response as a string. The string is interpreted by the encoding/charset set in the response Content-Type header. If no Content-Type is set, it falls back to UTF-8.

com.luckymarmot.ResponseRawBodyDynamicValue

Argument: request: string: (current request)

The UUID of the request to inspect the latest response from.

(current request)

function evaluate(context){
    var requestUuid = context.getCurrentRequest().id;
    var dv = new DynamicValue('com.luckymarmot.ResponseBodyLengthDynamicValue', {
        request: requestUuid
    });
    return dv.getEvaluatedString();
};

Response Header

Response Header¶

Extracts the value of a response header.

com.luckymarmot.ResponseHeaderDynamicValue

Argument: request: string: (current request)

The UUID of the request to inspect the latest response from.

(current request)

Argument: header: DynamicString: None
The name of the header to return.

function evaluate(context){
    var requestUuid = context.getCurrentRequest().id;
    var dv = new DynamicValue('com.luckymarmot.ResponseHeaderDynamicValue', {
        request: requestUuid,
        header: 'Date'
    });
    return dv.getEvaluatedString();
};