HTTP mapping keys

« Back to documentation home

Every key in HTTP mapping files, from the schema http-mapping.schema.json. The mapping explorer shows the same keys as a tree and checks a mapping against them.

One Traffic Parrot HTTP mapping: the request to match and the response to send, as a JSON file in the mappings directory (mappings/*.json). A check against this schema is stricter than loading the mapping: it rejects a misspelt key, which Traffic Parrot would ignore.

$schema

Reference to this schema for IDE support. Traffic Parrot ignores it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "$schema": "http://localhost:8080/schemas/http-mapping.schema.json"
}

id

Unique identifier for the mapping. Traffic Parrot-written files carry both id and uuid with the same value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "id": "0b1d4c39-6c2f-4e0e-9a51-8f2a3c5d7e90"
}

uuid

Alternative property name for the unique identifier.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "uuid": "0b1d4c39-6c2f-4e0e-9a51-8f2a3c5d7e90"
}

name

Human-readable name for the mapping.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "name": "get-open-orders"
}

persistent

Whether this mapping should be persisted to disk.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "persistent": true
}

priority

Priority of this mapping (default 5, lower number = higher priority).

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "priority": 1
}

scenarioName

Name of the state-machine scenario this mapping belongs to (not a Traffic Parrot scenario directory).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "scenarioName": "order-lifecycle"
}

requiredScenarioState

Required scenario state for this mapping to match.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "requiredScenarioState": "Started"
}

newScenarioState

New scenario state to set after this mapping is matched.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "newScenarioState": "order-placed"
}

insertionIndex

Internal ordering index. Accepted on input but not normally present in mapping files.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "insertionIndex": 0
}

postServeActions

Actions to perform after the response is served. Array form [{name, parameters}] or legacy object form {"<name>": {parameters}}.

Type
array | object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "postServeActions": [
    {
      "name": "webhook",
      "parameters": {
        "method": "POST",
        "url": "http://localhost:9090/callback"
      }
    }
  ]
}

serveEventListeners

Serve event listeners to notify.

Type
[object]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "serveEventListeners": [
    {
      "name": "webhook",
      "requestPhases": [
        "AFTER_COMPLETE"
      ],
      "parameters": {
        "method": "POST",
        "url": "http://localhost:9090/callback"
      }
    }
  ]
}

serveEventListeners[].name

Name of the serve event listener extension to notify, for example webhook.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "serveEventListeners": [
    {
      "name": "webhook"
    }
  ]
}

serveEventListeners[].requestPhases

Request phases at which the listener is called.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "serveEventListeners": [
    {
      "requestPhases": [
        "AFTER_COMPLETE"
      ]
    }
  ]
}

serveEventListeners[].parameters

Parameters passed to the listener. Their keys depend on the listener.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "serveEventListeners": [
    {
      "parameters": {
        "method": "POST",
        "url": "http://localhost:9090/callback"
      }
    }
  ]
}

metadata

Custom metadata associated with this mapping. Any key is accepted here.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "metadata": {
    "team": "payments",
    "ticket": "PAY-123"
  }
}

request

Request matching criteria. Use at most one of url / urlPattern / urlPath / urlPathPattern / urlPathTemplate. A misspelt key here is ignored when the mapping loads, which leaves a mapping that matches more requests than intended; a check against this schema rejects it.

Type
object
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "method": "GET",
    "urlPath": "/orders",
    "queryParameters": {
      "status": {
        "equalTo": "open"
      }
    }
  }
}

request.url

Exact URL including query string.

Type
string
Required
No
Exclusive with
urlPattern, urlPath, urlPathPattern, urlPathTemplate: a mapping carries only one of them and this key
Java DSL name
urlEqualTo (in Java code only, never a mapping key)
Docs
urlEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "url": "/orders?status=open"
  }
}

request.urlPattern

Regex on the full URL including query string.

Type
string
Required
No
Exclusive with
url, urlPath, urlPathPattern, urlPathTemplate: a mapping carries only one of them and this key
Java DSL name
urlMatching (in Java code only, never a mapping key)
Docs
urlMatching in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "urlPattern": "/orders/[0-9]+.*"
  }
}

request.urlPath

Exact URL path (query string ignored).

Type
string
Required
No
Exclusive with
url, urlPattern, urlPathPattern, urlPathTemplate: a mapping carries only one of them and this key
Java DSL name
urlPathEqualTo (in Java code only, never a mapping key)
Docs
urlPathEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "urlPath": "/orders"
  }
}

request.urlPathPattern

Regex on the URL path (query string ignored).

Type
string
Required
No
Exclusive with
url, urlPattern, urlPath, urlPathTemplate: a mapping carries only one of them and this key
Java DSL name
urlPathMatching (in Java code only, never a mapping key)
Docs
urlPathMatching in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "urlPathPattern": "/orders/[0-9]+"
  }
}

request.urlPathTemplate

RFC 6570 path template, e.g. /users/{id}. Enables pathParameters matching.

Type
string
Required
No
Exclusive with
url, urlPattern, urlPath, urlPathPattern: a mapping carries only one of them and this key
Docs
matchesPathTemplate in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "urlPathTemplate": "/orders/{orderId}"
  }
}

request.method

HTTP method to match. ANY matches every method. Traffic Parrot accepts any method name when it loads a mapping; this schema accepts only the methods listed here, CONNECT among them because the HTTP editor offers it.

Type
string
Required
No
Allowed values
"GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "TRACE", "CONNECT", "ANY", "GET_OR_HEAD"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "method": "GET"
  }
}

request.scheme

URL scheme to match.

Type
string
Required
No
Allowed values
"http", "https"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "scheme": "https"
  }
}

request.host

Matcher on the request host.

Type
matcher
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalTo": "api.example.com"
    }
  }
}

request.host.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalTo": "application/json"
    }
  }
}

request.host.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalTo": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "caseInsensitive": true
    }
  }
}

request.host.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalToJson": {
        "orderId": 42
      }
    }
  }
}

request.host.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "ignoreArrayOrder": true
    }
  }
}

request.host.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "ignoreExtraElements": true
    }
  }
}

request.host.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "treatNullAsAbsent": true
    }
  }
}

request.host.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesJsonSchema": {
        "type": "object",
        "required": [
          "orderId"
        ]
      }
    }
  }
}

request.host.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "schemaVersion": "V202012"
    }
  }
}

request.host.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalToXml": "<order><id>42</id></order>"
    }
  }
}

request.host.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalToXml": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "enablePlaceholders": true
    }
  }
}

request.host.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "placeholderOpeningDelimiterRegex": "\\[\\["
    }
  }
}

request.host.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "placeholderClosingDelimiterRegex": "\\]\\]"
    }
  }
}

request.host.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "exemptedComparisons": [
        "NAMESPACE_URI",
        "SCHEMA_LOCATION"
      ]
    }
  }
}

request.host.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "ignoreOrderOfSameNode": true
    }
  }
}

request.host.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "namespaceAwareness": "NONE"
    }
  }
}

request.host.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesJsonPath": "$.orderId"
    }
  }
}

request.host.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesXPath": "/order/id"
    }
  }
}

request.host.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "xPathNamespaces": {
        "ord": "http://example.com/orders"
      }
    }
  }
}

request.host.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "contains": "orderId"
    }
  }
}

request.host.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "contains": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "doesNotContain": "error"
    }
  }
}

request.host.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "doesNotContain": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matches": "ORD-[0-9]+"
    }
  }
}

request.host.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matches": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "doesNotMatch": ".*test.*"
    }
  }
}

request.host.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "doesNotMatch": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "before": "now +1 days"
    }
  }
}

request.host.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "after": "2026-01-01T00:00:00Z"
    }
  }
}

request.host.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "equalToDateTime": "now"
    }
  }
}

request.host.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "actualFormat": "dd/MM/yyyy"
    }
  }
}

request.host.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "truncateExpected": "first second of minute"
    }
  }
}

request.host.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "truncateActual": "first second of minute"
    }
  }
}

request.host.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "applyTruncationLast": true
    }
  }
}

request.host.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "expectedOffset": 1
    }
  }
}

request.host.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "expectedOffsetUnit": "SECONDS"
    }
  }
}

request.host.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "anything": "anything"
    }
  }
}

request.host.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "absent": true
    }
  }
}

request.host.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.host.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "and": [
        {
          "contains": "order"
        },
        {
          "doesNotContain": "test"
        }
      ]
    }
  }
}

request.host.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.host.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "or": [
        {
          "equalTo": "GB"
        },
        {
          "equalTo": "IE"
        }
      ]
    }
  }
}

request.host.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.host.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "not": {
        "contains": "test"
      }
    }
  }
}

request.host.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesPathTemplate": "/orders/{orderId}"
    }
  }
}

request.host.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "binaryEqualTo": "SGVsbG8="
    }
  }
}

request.host.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "binaryEqualTo": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesXml": "<order><id>42</id></order>"
    }
  }
}

request.host.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesXml": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.host.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesJson": {
        "orderId": 42
      }
    }
  }
}

request.host.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesGraphQL": "{ order(id: 42) { status } }"
    }
  }
}

request.host.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesSwiftField": {
        "field": "20",
        "matches": "REF[0-9]+"
      }
    }
  }
}

request.host.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesSwiftField": {
        "field": "20"
      }
    }
  }
}

request.host.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesSwiftField": {
        "matches": "REF[0-9]+"
      }
    }
  }
}

request.host.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesSwiftField": {
        "bodyFileName": "requests/mt103-match.json"
      }
    }
  }
}

request.host.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesFixField": {
        "field": "35",
        "matches": "D"
      }
    }
  }
}

request.host.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesFixField": {
        "field": "35"
      }
    }
  }
}

request.host.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesFixField": {
        "matches": "D"
      }
    }
  }
}

request.host.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesFixField": {
        "bodyFileName": "requests/fix-order-match.json"
      }
    }
  }
}

request.host.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "field": "COMMAREA.ACCOUNT-NO",
        "equalTo": "1234567890"
      }
    }
  }
}

request.host.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "field": "COMMAREA.ACCOUNT-NO"
      }
    }
  }
}

request.host.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "equalTo": "1234567890"
      }
    }
  }
}

request.host.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "matches": "[0-9]{10}"
      }
    }
  }
}

request.host.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "greaterThan": 100
      }
    }
  }
}

request.host.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "greaterThanOrEqualTo": 100
      }
    }
  }
}

request.host.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "lessThan": 1000
      }
    }
  }
}

request.host.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "lessThanOrEqualTo": 1000
      }
    }
  }
}

request.host.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "host": {
      "matchesCicsField": {
        "bodyFileName": "requests/cics-account-match.json"
      }
    }
  }
}

request.port

Port number to match.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "port": 8443
  }
}

request.clientIp

Matcher on the client IP address.

Type
matcher
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matches": "10\\.0\\..*"
    }
  }
}

request.clientIp.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "equalTo": "application/json"
    }
  }
}

request.clientIp.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "equalTo": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "caseInsensitive": true
    }
  }
}

request.clientIp.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "equalToJson": {
        "orderId": 42
      }
    }
  }
}

request.clientIp.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "ignoreArrayOrder": true
    }
  }
}

request.clientIp.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "ignoreExtraElements": true
    }
  }
}

request.clientIp.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "treatNullAsAbsent": true
    }
  }
}

request.clientIp.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesJsonSchema": {
        "type": "object",
        "required": [
          "orderId"
        ]
      }
    }
  }
}

request.clientIp.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "schemaVersion": "V202012"
    }
  }
}

request.clientIp.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "equalToXml": "<order><id>42</id></order>"
    }
  }
}

request.clientIp.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "equalToXml": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "enablePlaceholders": true
    }
  }
}

request.clientIp.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "placeholderOpeningDelimiterRegex": "\\[\\["
    }
  }
}

request.clientIp.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "placeholderClosingDelimiterRegex": "\\]\\]"
    }
  }
}

request.clientIp.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "exemptedComparisons": [
        "NAMESPACE_URI",
        "SCHEMA_LOCATION"
      ]
    }
  }
}

request.clientIp.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "ignoreOrderOfSameNode": true
    }
  }
}

request.clientIp.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "namespaceAwareness": "NONE"
    }
  }
}

request.clientIp.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesJsonPath": "$.orderId"
    }
  }
}

request.clientIp.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesXPath": "/order/id"
    }
  }
}

request.clientIp.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "xPathNamespaces": {
        "ord": "http://example.com/orders"
      }
    }
  }
}

request.clientIp.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "contains": "orderId"
    }
  }
}

request.clientIp.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "contains": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "doesNotContain": "error"
    }
  }
}

request.clientIp.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "doesNotContain": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matches": "ORD-[0-9]+"
    }
  }
}

request.clientIp.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matches": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "doesNotMatch": ".*test.*"
    }
  }
}

request.clientIp.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "doesNotMatch": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "before": "now +1 days"
    }
  }
}

request.clientIp.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "after": "2026-01-01T00:00:00Z"
    }
  }
}

request.clientIp.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "equalToDateTime": "now"
    }
  }
}

request.clientIp.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "actualFormat": "dd/MM/yyyy"
    }
  }
}

request.clientIp.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "truncateExpected": "first second of minute"
    }
  }
}

request.clientIp.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "truncateActual": "first second of minute"
    }
  }
}

request.clientIp.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "applyTruncationLast": true
    }
  }
}

request.clientIp.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "expectedOffset": 1
    }
  }
}

request.clientIp.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "expectedOffsetUnit": "SECONDS"
    }
  }
}

request.clientIp.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "anything": "anything"
    }
  }
}

request.clientIp.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "absent": true
    }
  }
}

request.clientIp.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.clientIp.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "and": [
        {
          "contains": "order"
        },
        {
          "doesNotContain": "test"
        }
      ]
    }
  }
}

request.clientIp.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.clientIp.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "or": [
        {
          "equalTo": "GB"
        },
        {
          "equalTo": "IE"
        }
      ]
    }
  }
}

request.clientIp.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.clientIp.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "not": {
        "contains": "test"
      }
    }
  }
}

request.clientIp.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesPathTemplate": "/orders/{orderId}"
    }
  }
}

request.clientIp.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "binaryEqualTo": "SGVsbG8="
    }
  }
}

request.clientIp.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "binaryEqualTo": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesXml": "<order><id>42</id></order>"
    }
  }
}

request.clientIp.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesXml": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.clientIp.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesJson": {
        "orderId": 42
      }
    }
  }
}

request.clientIp.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesGraphQL": "{ order(id: 42) { status } }"
    }
  }
}

request.clientIp.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesSwiftField": {
        "field": "20",
        "matches": "REF[0-9]+"
      }
    }
  }
}

request.clientIp.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesSwiftField": {
        "field": "20"
      }
    }
  }
}

request.clientIp.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesSwiftField": {
        "matches": "REF[0-9]+"
      }
    }
  }
}

request.clientIp.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesSwiftField": {
        "bodyFileName": "requests/mt103-match.json"
      }
    }
  }
}

request.clientIp.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesFixField": {
        "field": "35",
        "matches": "D"
      }
    }
  }
}

request.clientIp.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesFixField": {
        "field": "35"
      }
    }
  }
}

request.clientIp.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesFixField": {
        "matches": "D"
      }
    }
  }
}

request.clientIp.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesFixField": {
        "bodyFileName": "requests/fix-order-match.json"
      }
    }
  }
}

request.clientIp.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "field": "COMMAREA.ACCOUNT-NO",
        "equalTo": "1234567890"
      }
    }
  }
}

request.clientIp.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "field": "COMMAREA.ACCOUNT-NO"
      }
    }
  }
}

request.clientIp.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "equalTo": "1234567890"
      }
    }
  }
}

request.clientIp.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "matches": "[0-9]{10}"
      }
    }
  }
}

request.clientIp.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "greaterThan": 100
      }
    }
  }
}

request.clientIp.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "greaterThanOrEqualTo": 100
      }
    }
  }
}

request.clientIp.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "lessThan": 1000
      }
    }
  }
}

request.clientIp.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "lessThanOrEqualTo": 1000
      }
    }
  }
}

request.clientIp.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "clientIp": {
      "matchesCicsField": {
        "bodyFileName": "requests/cics-account-match.json"
      }
    }
  }
}

request.headers

Request headers to match: header name to matcher (or hasExactly / includes multi-value form).

Type
{name: matcher}
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "Accept": {
        "contains": "json"
      }
    }
  }
}

request.headers.*

Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.

Type
object
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

request.headers.*.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "equalTo": "application/json"
      }
    }
  }
}

request.headers.*.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "equalTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "caseInsensitive": true
      }
    }
  }
}

request.headers.*.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "equalToJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.headers.*.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "ignoreArrayOrder": true
      }
    }
  }
}

request.headers.*.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "ignoreExtraElements": true
      }
    }
  }
}

request.headers.*.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "treatNullAsAbsent": true
      }
    }
  }
}

request.headers.*.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    }
  }
}

request.headers.*.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "schemaVersion": "V202012"
      }
    }
  }
}

request.headers.*.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "equalToXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.headers.*.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "equalToXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "enablePlaceholders": true
      }
    }
  }
}

request.headers.*.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    }
  }
}

request.headers.*.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    }
  }
}

request.headers.*.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    }
  }
}

request.headers.*.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "ignoreOrderOfSameNode": true
      }
    }
  }
}

request.headers.*.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "namespaceAwareness": "NONE"
      }
    }
  }
}

request.headers.*.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesJsonPath": "$.orderId"
      }
    }
  }
}

request.headers.*.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesXPath": "/order/id"
      }
    }
  }
}

request.headers.*.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    }
  }
}

request.headers.*.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "contains": "orderId"
      }
    }
  }
}

request.headers.*.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "contains": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "doesNotContain": "error"
      }
    }
  }
}

request.headers.*.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "doesNotContain": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matches": "ORD-[0-9]+"
      }
    }
  }
}

request.headers.*.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matches": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "doesNotMatch": ".*test.*"
      }
    }
  }
}

request.headers.*.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "doesNotMatch": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "before": "now +1 days"
      }
    }
  }
}

request.headers.*.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "after": "2026-01-01T00:00:00Z"
      }
    }
  }
}

request.headers.*.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "equalToDateTime": "now"
      }
    }
  }
}

request.headers.*.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "actualFormat": "dd/MM/yyyy"
      }
    }
  }
}

request.headers.*.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "truncateExpected": "first second of minute"
      }
    }
  }
}

request.headers.*.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "truncateActual": "first second of minute"
      }
    }
  }
}

request.headers.*.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "applyTruncationLast": true
      }
    }
  }
}

request.headers.*.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "expectedOffset": 1
      }
    }
  }
}

request.headers.*.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "expectedOffsetUnit": "SECONDS"
      }
    }
  }
}

request.headers.*.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "anything": "anything"
      }
    }
  }
}

request.headers.*.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "absent": true
      }
    }
  }
}

request.headers.*.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "and": [
          {
            "contains": "order"
          },
          {
            "doesNotContain": "test"
          }
        ]
      }
    }
  }
}

request.headers.*.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "or": [
          {
            "equalTo": "GB"
          },
          {
            "equalTo": "IE"
          }
        ]
      }
    }
  }
}

request.headers.*.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "not": {
          "contains": "test"
        }
      }
    }
  }
}

request.headers.*.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    }
  }
}

request.headers.*.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "binaryEqualTo": "SGVsbG8="
      }
    }
  }
}

request.headers.*.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "binaryEqualTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.headers.*.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.headers.*.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.headers.*.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    }
  }
}

request.headers.*.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.headers.*.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    }
  }
}

request.headers.*.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.headers.*.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesSwiftField": {
          "bodyFileName": "requests/mt103-match.json"
        }
      }
    }
  }
}

request.headers.*.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    }
  }
}

request.headers.*.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesFixField": {
          "field": "35"
        }
      }
    }
  }
}

request.headers.*.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesFixField": {
          "matches": "D"
        }
      }
    }
  }
}

request.headers.*.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesFixField": {
          "bodyFileName": "requests/fix-order-match.json"
        }
      }
    }
  }
}

request.headers.*.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO"
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    }
  }
}

request.headers.*.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "matchesCicsField": {
          "bodyFileName": "requests/cics-account-match.json"
        }
      }
    }
  }
}

request.headers.*.hasExactly

The header or parameter has exactly these values, one matching each matcher, in any order.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "hasExactly": [
          {
            "equalTo": "red"
          },
          {
            "equalTo": "blue"
          }
        ]
      }
    }
  }
}

request.headers.*.includes

The header or parameter has, among its values, one matching each matcher.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "headers": {
      "name": {
        "includes": [
          {
            "equalTo": "red"
          }
        ]
      }
    }
  }
}

request.queryParameters

Query parameters to match.

Type
{name: matcher}
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "status": {
        "equalTo": "open"
      }
    }
  }
}

request.queryParameters.*

Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.

Type
object
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

request.queryParameters.*.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "equalTo": "application/json"
      }
    }
  }
}

request.queryParameters.*.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "equalTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "caseInsensitive": true
      }
    }
  }
}

request.queryParameters.*.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "equalToJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.queryParameters.*.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "ignoreArrayOrder": true
      }
    }
  }
}

request.queryParameters.*.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "ignoreExtraElements": true
      }
    }
  }
}

request.queryParameters.*.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "treatNullAsAbsent": true
      }
    }
  }
}

request.queryParameters.*.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    }
  }
}

request.queryParameters.*.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "schemaVersion": "V202012"
      }
    }
  }
}

request.queryParameters.*.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "equalToXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.queryParameters.*.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "equalToXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "enablePlaceholders": true
      }
    }
  }
}

request.queryParameters.*.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    }
  }
}

request.queryParameters.*.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    }
  }
}

request.queryParameters.*.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    }
  }
}

request.queryParameters.*.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "ignoreOrderOfSameNode": true
      }
    }
  }
}

request.queryParameters.*.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "namespaceAwareness": "NONE"
      }
    }
  }
}

request.queryParameters.*.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesJsonPath": "$.orderId"
      }
    }
  }
}

request.queryParameters.*.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesXPath": "/order/id"
      }
    }
  }
}

request.queryParameters.*.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    }
  }
}

request.queryParameters.*.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "contains": "orderId"
      }
    }
  }
}

request.queryParameters.*.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "contains": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "doesNotContain": "error"
      }
    }
  }
}

request.queryParameters.*.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "doesNotContain": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matches": "ORD-[0-9]+"
      }
    }
  }
}

request.queryParameters.*.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matches": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "doesNotMatch": ".*test.*"
      }
    }
  }
}

request.queryParameters.*.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "doesNotMatch": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "before": "now +1 days"
      }
    }
  }
}

request.queryParameters.*.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "after": "2026-01-01T00:00:00Z"
      }
    }
  }
}

request.queryParameters.*.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "equalToDateTime": "now"
      }
    }
  }
}

request.queryParameters.*.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "actualFormat": "dd/MM/yyyy"
      }
    }
  }
}

request.queryParameters.*.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "truncateExpected": "first second of minute"
      }
    }
  }
}

request.queryParameters.*.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "truncateActual": "first second of minute"
      }
    }
  }
}

request.queryParameters.*.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "applyTruncationLast": true
      }
    }
  }
}

request.queryParameters.*.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "expectedOffset": 1
      }
    }
  }
}

request.queryParameters.*.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "expectedOffsetUnit": "SECONDS"
      }
    }
  }
}

request.queryParameters.*.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "anything": "anything"
      }
    }
  }
}

request.queryParameters.*.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "absent": true
      }
    }
  }
}

request.queryParameters.*.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.queryParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "and": [
          {
            "contains": "order"
          },
          {
            "doesNotContain": "test"
          }
        ]
      }
    }
  }
}

request.queryParameters.*.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.queryParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "or": [
          {
            "equalTo": "GB"
          },
          {
            "equalTo": "IE"
          }
        ]
      }
    }
  }
}

request.queryParameters.*.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.queryParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "not": {
          "contains": "test"
        }
      }
    }
  }
}

request.queryParameters.*.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    }
  }
}

request.queryParameters.*.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "binaryEqualTo": "SGVsbG8="
      }
    }
  }
}

request.queryParameters.*.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "binaryEqualTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.queryParameters.*.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.queryParameters.*.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.queryParameters.*.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    }
  }
}

request.queryParameters.*.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.queryParameters.*.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    }
  }
}

request.queryParameters.*.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.queryParameters.*.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesSwiftField": {
          "bodyFileName": "requests/mt103-match.json"
        }
      }
    }
  }
}

request.queryParameters.*.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    }
  }
}

request.queryParameters.*.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesFixField": {
          "field": "35"
        }
      }
    }
  }
}

request.queryParameters.*.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesFixField": {
          "matches": "D"
        }
      }
    }
  }
}

request.queryParameters.*.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesFixField": {
          "bodyFileName": "requests/fix-order-match.json"
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO"
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    }
  }
}

request.queryParameters.*.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "matchesCicsField": {
          "bodyFileName": "requests/cics-account-match.json"
        }
      }
    }
  }
}

request.queryParameters.*.hasExactly

The header or parameter has exactly these values, one matching each matcher, in any order.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.queryParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "hasExactly": [
          {
            "equalTo": "red"
          },
          {
            "equalTo": "blue"
          }
        ]
      }
    }
  }
}

request.queryParameters.*.includes

The header or parameter has, among its values, one matching each matcher.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.queryParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "queryParameters": {
      "name": {
        "includes": [
          {
            "equalTo": "red"
          }
        ]
      }
    }
  }
}

request.formParameters

Form (application/x-www-form-urlencoded) parameters to match.

Type
{name: matcher}
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "grant_type": {
        "equalTo": "client_credentials"
      }
    }
  }
}

request.formParameters.*

Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.

Type
object
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

request.formParameters.*.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "equalTo": "application/json"
      }
    }
  }
}

request.formParameters.*.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "equalTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "caseInsensitive": true
      }
    }
  }
}

request.formParameters.*.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "equalToJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.formParameters.*.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "ignoreArrayOrder": true
      }
    }
  }
}

request.formParameters.*.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "ignoreExtraElements": true
      }
    }
  }
}

request.formParameters.*.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "treatNullAsAbsent": true
      }
    }
  }
}

request.formParameters.*.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    }
  }
}

request.formParameters.*.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "schemaVersion": "V202012"
      }
    }
  }
}

request.formParameters.*.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "equalToXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.formParameters.*.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "equalToXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "enablePlaceholders": true
      }
    }
  }
}

request.formParameters.*.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    }
  }
}

request.formParameters.*.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    }
  }
}

request.formParameters.*.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    }
  }
}

request.formParameters.*.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "ignoreOrderOfSameNode": true
      }
    }
  }
}

request.formParameters.*.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "namespaceAwareness": "NONE"
      }
    }
  }
}

request.formParameters.*.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesJsonPath": "$.orderId"
      }
    }
  }
}

request.formParameters.*.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesXPath": "/order/id"
      }
    }
  }
}

request.formParameters.*.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    }
  }
}

request.formParameters.*.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "contains": "orderId"
      }
    }
  }
}

request.formParameters.*.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "contains": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "doesNotContain": "error"
      }
    }
  }
}

request.formParameters.*.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "doesNotContain": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matches": "ORD-[0-9]+"
      }
    }
  }
}

request.formParameters.*.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matches": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "doesNotMatch": ".*test.*"
      }
    }
  }
}

request.formParameters.*.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "doesNotMatch": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "before": "now +1 days"
      }
    }
  }
}

request.formParameters.*.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "after": "2026-01-01T00:00:00Z"
      }
    }
  }
}

request.formParameters.*.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "equalToDateTime": "now"
      }
    }
  }
}

request.formParameters.*.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "actualFormat": "dd/MM/yyyy"
      }
    }
  }
}

request.formParameters.*.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "truncateExpected": "first second of minute"
      }
    }
  }
}

request.formParameters.*.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "truncateActual": "first second of minute"
      }
    }
  }
}

request.formParameters.*.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "applyTruncationLast": true
      }
    }
  }
}

request.formParameters.*.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "expectedOffset": 1
      }
    }
  }
}

request.formParameters.*.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "expectedOffsetUnit": "SECONDS"
      }
    }
  }
}

request.formParameters.*.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "anything": "anything"
      }
    }
  }
}

request.formParameters.*.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "absent": true
      }
    }
  }
}

request.formParameters.*.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.formParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "and": [
          {
            "contains": "order"
          },
          {
            "doesNotContain": "test"
          }
        ]
      }
    }
  }
}

request.formParameters.*.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.formParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "or": [
          {
            "equalTo": "GB"
          },
          {
            "equalTo": "IE"
          }
        ]
      }
    }
  }
}

request.formParameters.*.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.formParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "not": {
          "contains": "test"
        }
      }
    }
  }
}

request.formParameters.*.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    }
  }
}

request.formParameters.*.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "binaryEqualTo": "SGVsbG8="
      }
    }
  }
}

request.formParameters.*.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "binaryEqualTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.formParameters.*.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.formParameters.*.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.formParameters.*.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    }
  }
}

request.formParameters.*.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.formParameters.*.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    }
  }
}

request.formParameters.*.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.formParameters.*.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesSwiftField": {
          "bodyFileName": "requests/mt103-match.json"
        }
      }
    }
  }
}

request.formParameters.*.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    }
  }
}

request.formParameters.*.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesFixField": {
          "field": "35"
        }
      }
    }
  }
}

request.formParameters.*.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesFixField": {
          "matches": "D"
        }
      }
    }
  }
}

request.formParameters.*.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesFixField": {
          "bodyFileName": "requests/fix-order-match.json"
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO"
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    }
  }
}

request.formParameters.*.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "matchesCicsField": {
          "bodyFileName": "requests/cics-account-match.json"
        }
      }
    }
  }
}

request.formParameters.*.hasExactly

The header or parameter has exactly these values, one matching each matcher, in any order.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.formParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "hasExactly": [
          {
            "equalTo": "red"
          },
          {
            "equalTo": "blue"
          }
        ]
      }
    }
  }
}

request.formParameters.*.includes

The header or parameter has, among its values, one matching each matcher.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.formParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "formParameters": {
      "name": {
        "includes": [
          {
            "equalTo": "red"
          }
        ]
      }
    }
  }
}

request.pathParameters

Path parameters to match. Only meaningful together with urlPathTemplate.

Type
{name: matcher}
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "orderId": {
        "matches": "[0-9]+"
      }
    }
  }
}

request.pathParameters.*

A single value matcher in a position where Traffic Parrot will NOT resolve an externalised value. Identical to stringValueMatcher except that the {"bodyFileName": "<file>"} form is refused. Used for host, clientIp, header, query, form, path, cookie and multipart matchers, and for any matcher nested inside and / or / not: Traffic Parrot rejects a bodyFileName reference in all of them.

Type
matcher
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

request.pathParameters.*.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "equalTo": "application/json"
      }
    }
  }
}

request.pathParameters.*.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "equalTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "caseInsensitive": true
      }
    }
  }
}

request.pathParameters.*.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "equalToJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.pathParameters.*.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "ignoreArrayOrder": true
      }
    }
  }
}

request.pathParameters.*.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "ignoreExtraElements": true
      }
    }
  }
}

request.pathParameters.*.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "treatNullAsAbsent": true
      }
    }
  }
}

request.pathParameters.*.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    }
  }
}

request.pathParameters.*.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "schemaVersion": "V202012"
      }
    }
  }
}

request.pathParameters.*.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "equalToXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.pathParameters.*.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "equalToXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "enablePlaceholders": true
      }
    }
  }
}

request.pathParameters.*.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    }
  }
}

request.pathParameters.*.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    }
  }
}

request.pathParameters.*.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    }
  }
}

request.pathParameters.*.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "ignoreOrderOfSameNode": true
      }
    }
  }
}

request.pathParameters.*.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "namespaceAwareness": "NONE"
      }
    }
  }
}

request.pathParameters.*.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesJsonPath": "$.orderId"
      }
    }
  }
}

request.pathParameters.*.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesXPath": "/order/id"
      }
    }
  }
}

request.pathParameters.*.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    }
  }
}

request.pathParameters.*.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "contains": "orderId"
      }
    }
  }
}

request.pathParameters.*.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "contains": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "doesNotContain": "error"
      }
    }
  }
}

request.pathParameters.*.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "doesNotContain": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matches": "ORD-[0-9]+"
      }
    }
  }
}

request.pathParameters.*.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matches": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "doesNotMatch": ".*test.*"
      }
    }
  }
}

request.pathParameters.*.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "doesNotMatch": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "before": "now +1 days"
      }
    }
  }
}

request.pathParameters.*.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "after": "2026-01-01T00:00:00Z"
      }
    }
  }
}

request.pathParameters.*.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "equalToDateTime": "now"
      }
    }
  }
}

request.pathParameters.*.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "actualFormat": "dd/MM/yyyy"
      }
    }
  }
}

request.pathParameters.*.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "truncateExpected": "first second of minute"
      }
    }
  }
}

request.pathParameters.*.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "truncateActual": "first second of minute"
      }
    }
  }
}

request.pathParameters.*.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "applyTruncationLast": true
      }
    }
  }
}

request.pathParameters.*.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "expectedOffset": 1
      }
    }
  }
}

request.pathParameters.*.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "expectedOffsetUnit": "SECONDS"
      }
    }
  }
}

request.pathParameters.*.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "anything": "anything"
      }
    }
  }
}

request.pathParameters.*.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "absent": true
      }
    }
  }
}

request.pathParameters.*.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.pathParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "and": [
          {
            "contains": "order"
          },
          {
            "doesNotContain": "test"
          }
        ]
      }
    }
  }
}

request.pathParameters.*.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.pathParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "or": [
          {
            "equalTo": "GB"
          },
          {
            "equalTo": "IE"
          }
        ]
      }
    }
  }
}

request.pathParameters.*.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.pathParameters.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "not": {
          "contains": "test"
        }
      }
    }
  }
}

request.pathParameters.*.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    }
  }
}

request.pathParameters.*.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "binaryEqualTo": "SGVsbG8="
      }
    }
  }
}

request.pathParameters.*.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "binaryEqualTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.pathParameters.*.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.pathParameters.*.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.pathParameters.*.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    }
  }
}

request.pathParameters.*.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.pathParameters.*.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    }
  }
}

request.pathParameters.*.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.pathParameters.*.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesSwiftField": {
          "bodyFileName": "requests/mt103-match.json"
        }
      }
    }
  }
}

request.pathParameters.*.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    }
  }
}

request.pathParameters.*.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesFixField": {
          "field": "35"
        }
      }
    }
  }
}

request.pathParameters.*.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesFixField": {
          "matches": "D"
        }
      }
    }
  }
}

request.pathParameters.*.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesFixField": {
          "bodyFileName": "requests/fix-order-match.json"
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO"
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    }
  }
}

request.pathParameters.*.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "pathParameters": {
      "name": {
        "matchesCicsField": {
          "bodyFileName": "requests/cics-account-match.json"
        }
      }
    }
  }
}

request.cookies

Cookies to match.

Type
{name: matcher}
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "session": {
        "matches": ".+"
      }
    }
  }
}

request.cookies.*

A single value matcher in a position where Traffic Parrot will NOT resolve an externalised value. Identical to stringValueMatcher except that the {"bodyFileName": "<file>"} form is refused. Used for host, clientIp, header, query, form, path, cookie and multipart matchers, and for any matcher nested inside and / or / not: Traffic Parrot rejects a bodyFileName reference in all of them.

Type
matcher
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

request.cookies.*.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "equalTo": "application/json"
      }
    }
  }
}

request.cookies.*.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "equalTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "caseInsensitive": true
      }
    }
  }
}

request.cookies.*.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "equalToJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.cookies.*.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "ignoreArrayOrder": true
      }
    }
  }
}

request.cookies.*.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "ignoreExtraElements": true
      }
    }
  }
}

request.cookies.*.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "treatNullAsAbsent": true
      }
    }
  }
}

request.cookies.*.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    }
  }
}

request.cookies.*.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "schemaVersion": "V202012"
      }
    }
  }
}

request.cookies.*.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "equalToXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.cookies.*.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "equalToXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "enablePlaceholders": true
      }
    }
  }
}

request.cookies.*.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    }
  }
}

request.cookies.*.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    }
  }
}

request.cookies.*.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    }
  }
}

request.cookies.*.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "ignoreOrderOfSameNode": true
      }
    }
  }
}

request.cookies.*.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "namespaceAwareness": "NONE"
      }
    }
  }
}

request.cookies.*.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesJsonPath": "$.orderId"
      }
    }
  }
}

request.cookies.*.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesXPath": "/order/id"
      }
    }
  }
}

request.cookies.*.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    }
  }
}

request.cookies.*.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "contains": "orderId"
      }
    }
  }
}

request.cookies.*.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "contains": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "doesNotContain": "error"
      }
    }
  }
}

request.cookies.*.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "doesNotContain": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matches": "ORD-[0-9]+"
      }
    }
  }
}

request.cookies.*.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matches": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "doesNotMatch": ".*test.*"
      }
    }
  }
}

request.cookies.*.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "doesNotMatch": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "before": "now +1 days"
      }
    }
  }
}

request.cookies.*.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "after": "2026-01-01T00:00:00Z"
      }
    }
  }
}

request.cookies.*.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "equalToDateTime": "now"
      }
    }
  }
}

request.cookies.*.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "actualFormat": "dd/MM/yyyy"
      }
    }
  }
}

request.cookies.*.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "truncateExpected": "first second of minute"
      }
    }
  }
}

request.cookies.*.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "truncateActual": "first second of minute"
      }
    }
  }
}

request.cookies.*.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "applyTruncationLast": true
      }
    }
  }
}

request.cookies.*.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "expectedOffset": 1
      }
    }
  }
}

request.cookies.*.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "expectedOffsetUnit": "SECONDS"
      }
    }
  }
}

request.cookies.*.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "anything": "anything"
      }
    }
  }
}

request.cookies.*.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "absent": true
      }
    }
  }
}

request.cookies.*.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.cookies.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "and": [
          {
            "contains": "order"
          },
          {
            "doesNotContain": "test"
          }
        ]
      }
    }
  }
}

request.cookies.*.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.cookies.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "or": [
          {
            "equalTo": "GB"
          },
          {
            "equalTo": "IE"
          }
        ]
      }
    }
  }
}

request.cookies.*.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.cookies.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "not": {
          "contains": "test"
        }
      }
    }
  }
}

request.cookies.*.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    }
  }
}

request.cookies.*.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "binaryEqualTo": "SGVsbG8="
      }
    }
  }
}

request.cookies.*.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "binaryEqualTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesXml": "<order><id>42</id></order>"
      }
    }
  }
}

request.cookies.*.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    }
  }
}

request.cookies.*.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.cookies.*.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    }
  }
}

request.cookies.*.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.cookies.*.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    }
  }
}

request.cookies.*.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.cookies.*.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesSwiftField": {
          "bodyFileName": "requests/mt103-match.json"
        }
      }
    }
  }
}

request.cookies.*.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    }
  }
}

request.cookies.*.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesFixField": {
          "field": "35"
        }
      }
    }
  }
}

request.cookies.*.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesFixField": {
          "matches": "D"
        }
      }
    }
  }
}

request.cookies.*.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesFixField": {
          "bodyFileName": "requests/fix-order-match.json"
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO"
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    }
  }
}

request.cookies.*.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "cookies": {
      "name": {
        "matchesCicsField": {
          "bodyFileName": "requests/cics-account-match.json"
        }
      }
    }
  }
}

request.basicAuth

Basic authentication credentials to match.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "basicAuth": {
      "username": "api-user",
      "password": "secret"
    }
  }
}

request.basicAuth.username

User name the request's Basic Authorization header must carry.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "basicAuth": {
      "username": "api-user"
    }
  }
}

request.basicAuth.password

Password the request's Basic Authorization header must carry.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "basicAuth": {
      "password": "secret"
    }
  }
}

request.bodyPatterns

Request body matching patterns. All patterns must match.

Type
[matcher]
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesJsonPath": "$.items[?(@.quantity > 0)]"
      }
    ]
  }
}

request.bodyPatterns[].equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "equalTo": "application/json"
      }
    ]
  }
}

request.bodyPatterns[].equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "equalTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "caseInsensitive": true
      }
    ]
  }
}

request.bodyPatterns[].equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "equalToJson": {
          "orderId": 42
        }
      }
    ]
  }
}

request.bodyPatterns[].ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "ignoreArrayOrder": true
      }
    ]
  }
}

request.bodyPatterns[].ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "ignoreExtraElements": true
      }
    ]
  }
}

request.bodyPatterns[].treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "treatNullAsAbsent": true
      }
    ]
  }
}

request.bodyPatterns[].matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    ]
  }
}

request.bodyPatterns[].schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "schemaVersion": "V202012"
      }
    ]
  }
}

request.bodyPatterns[].equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "equalToXml": "<order><id>42</id></order>"
      }
    ]
  }
}

request.bodyPatterns[].equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "equalToXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "enablePlaceholders": true
      }
    ]
  }
}

request.bodyPatterns[].placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    ]
  }
}

request.bodyPatterns[].placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    ]
  }
}

request.bodyPatterns[].exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    ]
  }
}

request.bodyPatterns[].ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "ignoreOrderOfSameNode": true
      }
    ]
  }
}

request.bodyPatterns[].namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "namespaceAwareness": "NONE"
      }
    ]
  }
}

request.bodyPatterns[].matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesJsonPath": "$.orderId"
      }
    ]
  }
}

request.bodyPatterns[].matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesXPath": "/order/id"
      }
    ]
  }
}

request.bodyPatterns[].xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    ]
  }
}

request.bodyPatterns[].contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "contains": "orderId"
      }
    ]
  }
}

request.bodyPatterns[].contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "contains": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "doesNotContain": "error"
      }
    ]
  }
}

request.bodyPatterns[].doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "doesNotContain": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matches": "ORD-[0-9]+"
      }
    ]
  }
}

request.bodyPatterns[].matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matches": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "doesNotMatch": ".*test.*"
      }
    ]
  }
}

request.bodyPatterns[].doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "doesNotMatch": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "before": "now +1 days"
      }
    ]
  }
}

request.bodyPatterns[].after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "after": "2026-01-01T00:00:00Z"
      }
    ]
  }
}

request.bodyPatterns[].equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "equalToDateTime": "now"
      }
    ]
  }
}

request.bodyPatterns[].actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "actualFormat": "dd/MM/yyyy"
      }
    ]
  }
}

request.bodyPatterns[].truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "truncateExpected": "first second of minute"
      }
    ]
  }
}

request.bodyPatterns[].truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "truncateActual": "first second of minute"
      }
    ]
  }
}

request.bodyPatterns[].applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "applyTruncationLast": true
      }
    ]
  }
}

request.bodyPatterns[].expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "expectedOffset": 1
      }
    ]
  }
}

request.bodyPatterns[].expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "expectedOffsetUnit": "SECONDS"
      }
    ]
  }
}

request.bodyPatterns[].anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "anything": "anything"
      }
    ]
  }
}

request.bodyPatterns[].absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "absent": true
      }
    ]
  }
}

request.bodyPatterns[].and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.bodyPatterns.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "and": [
          {
            "contains": "order"
          },
          {
            "doesNotContain": "test"
          }
        ]
      }
    ]
  }
}

request.bodyPatterns[].or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.bodyPatterns.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "or": [
          {
            "equalTo": "GB"
          },
          {
            "equalTo": "IE"
          }
        ]
      }
    ]
  }
}

request.bodyPatterns[].not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.bodyPatterns.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "not": {
          "contains": "test"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    ]
  }
}

request.bodyPatterns[].binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "binaryEqualTo": "SGVsbG8="
      }
    ]
  }
}

request.bodyPatterns[].binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "binaryEqualTo": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesXml": "<order><id>42</id></order>"
      }
    ]
  }
}

request.bodyPatterns[].matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesXml": {
          "bodyFileName": "requests/expected-order.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesJson": {
          "orderId": 42
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    ]
  }
}

request.bodyPatterns[].matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesSwiftField": {
          "bodyFileName": "requests/mt103-match.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesFixField": {
          "field": "35"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesFixField": {
          "matches": "D"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesFixField": {
          "bodyFileName": "requests/fix-order-match.json"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    ]
  }
}

request.bodyPatterns[].matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyPatterns": [
      {
        "matchesCicsField": {
          "bodyFileName": "requests/cics-account-match.json"
        }
      }
    ]
  }
}

request.multipartPatterns

Multipart request body matching patterns.

Type
[object]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "name": "file",
        "matchingType": "ANY",
        "bodyPatterns": [
          {
            "contains": "invoice"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].name

Name of the part, from its Content-Disposition header.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "name": "file"
      }
    ]
  }
}

request.multipartPatterns[].fileName

File name of the part, from its Content-Disposition header.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "fileName": "invoice.pdf"
      }
    ]
  }
}

request.multipartPatterns[].matchingType

ALL: every part must match this pattern. ANY: at least one part must.

Type
string
Required
No
Allowed values
"ALL", "ANY"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "matchingType": "ANY"
      }
    ]
  }
}

request.multipartPatterns[].headers

Matchers the part's headers must satisfy, by header name.

Type
{name: matcher}
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "Content-Type": {
            "equalTo": "application/pdf"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*

Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.

Type
object
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includes
Explorer
Open this key in the mapping explorer

request.multipartPatterns[].headers.*.equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "equalTo": "application/json"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "equalTo": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "caseInsensitive": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "equalToJson": {
              "orderId": 42
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "ignoreArrayOrder": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "ignoreExtraElements": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "treatNullAsAbsent": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesJsonSchema": {
              "type": "object",
              "required": [
                "orderId"
              ]
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "schemaVersion": "V202012"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "equalToXml": "<order><id>42</id></order>"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "equalToXml": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "enablePlaceholders": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "placeholderOpeningDelimiterRegex": "\\[\\["
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "placeholderClosingDelimiterRegex": "\\]\\]"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "exemptedComparisons": [
              "NAMESPACE_URI",
              "SCHEMA_LOCATION"
            ]
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "ignoreOrderOfSameNode": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "namespaceAwareness": "NONE"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesJsonPath": "$.orderId"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesXPath": "/order/id"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "xPathNamespaces": {
              "ord": "http://example.com/orders"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "contains": "orderId"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "contains": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "doesNotContain": "error"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "doesNotContain": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matches": "ORD-[0-9]+"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matches": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "doesNotMatch": ".*test.*"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "doesNotMatch": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "before": "now +1 days"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "after": "2026-01-01T00:00:00Z"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "equalToDateTime": "now"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "actualFormat": "dd/MM/yyyy"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "truncateExpected": "first second of minute"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "truncateActual": "first second of minute"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "applyTruncationLast": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "expectedOffset": 1
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "expectedOffsetUnit": "SECONDS"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "anything": "anything"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "absent": true
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "and": [
              {
                "contains": "order"
              },
              {
                "doesNotContain": "test"
              }
            ]
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "or": [
              {
                "equalTo": "GB"
              },
              {
                "equalTo": "IE"
              }
            ]
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "not": {
              "contains": "test"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesPathTemplate": "/orders/{orderId}"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "binaryEqualTo": "SGVsbG8="
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "binaryEqualTo": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesXml": "<order><id>42</id></order>"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesXml": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesJson": {
              "orderId": 42
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesGraphQL": "{ order(id: 42) { status } }"
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesSwiftField": {
              "field": "20",
              "matches": "REF[0-9]+"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesSwiftField": {
              "field": "20"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesSwiftField": {
              "matches": "REF[0-9]+"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesSwiftField": {
              "bodyFileName": "requests/mt103-match.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesFixField": {
              "field": "35",
              "matches": "D"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesFixField": {
              "field": "35"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesFixField": {
              "matches": "D"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesFixField": {
              "bodyFileName": "requests/fix-order-match.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "field": "COMMAREA.ACCOUNT-NO",
              "equalTo": "1234567890"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "field": "COMMAREA.ACCOUNT-NO"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "equalTo": "1234567890"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "matches": "[0-9]{10}"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "greaterThan": 100
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "greaterThanOrEqualTo": 100
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "lessThan": 1000
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "lessThanOrEqualTo": 1000
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "matchesCicsField": {
              "bodyFileName": "requests/cics-account-match.json"
            }
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.hasExactly

The header or parameter has exactly these values, one matching each matcher, in any order.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "hasExactly": [
              {
                "equalTo": "red"
              },
              {
                "equalTo": "blue"
              }
            ]
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].headers.*.includes

The header or parameter has, among its values, one matching each matcher.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].headers.*.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "headers": {
          "name": {
            "includes": [
              {
                "equalTo": "red"
              }
            ]
          }
        }
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns

Matchers the part's body must satisfy.

Type
[matcher]
Required
No
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "contains": "invoice"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].equalTo

Exact string equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "equalTo": "application/json"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].equalTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "equalTo": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].caseInsensitive

Option for equalTo.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "caseInsensitive": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].equalToJson

Semantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "equalToJson": {
              "orderId": 42
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].ignoreArrayOrder

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "ignoreArrayOrder": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].ignoreExtraElements

Option for equalToJson / matchesJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "ignoreExtraElements": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].treatNullAsAbsent

Option for equalToJson.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "treatNullAsAbsent": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesJsonSchema

Value must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonSchema (in Java code only, never a mapping key)
Docs
matchesJsonSchema in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesJsonSchema": {
              "type": "object",
              "required": [
                "orderId"
              ]
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].schemaVersion

Option for matchesJsonSchema (default V202012).

Type
string
Required
No
Allowed values
"V4", "V6", "V7", "V201909", "V202012"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "schemaVersion": "V202012"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].equalToXml

Semantic XML equality.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "equalToXml": "<order><id>42</id></order>"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].equalToXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "equalToXml": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].enablePlaceholders

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "enablePlaceholders": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].placeholderOpeningDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "placeholderOpeningDelimiterRegex": "\\[\\["
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].placeholderClosingDelimiterRegex

Option for equalToXml.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "placeholderClosingDelimiterRegex": "\\]\\]"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].exemptedComparisons

Option for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "exemptedComparisons": [
              "NAMESPACE_URI",
              "SCHEMA_LOCATION"
            ]
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].ignoreOrderOfSameNode

Option for equalToXml.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "ignoreOrderOfSameNode": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].namespaceAwareness

Option for equalToXml.

Type
string
Required
No
Allowed values
"STRICT", "LEGACY", "NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "namespaceAwareness": "NONE"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesJsonPath

JSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingJsonPath (in Java code only, never a mapping key)
Docs
matchesJsonPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesJsonPath": "$.orderId"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesXPath

XPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matchingXPath (in Java code only, never a mapping key)
Docs
matchesXPath in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesXPath": "/order/id"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].xPathNamespaces

Option for matchesXPath: prefix to namespace URI.

Type
{name: string}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "xPathNamespaces": {
              "ord": "http://example.com/orders"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].contains

Substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
containing (in Java code only, never a mapping key)
Docs
contains in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "contains": "orderId"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].contains.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "contains": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].doesNotContain

Negative substring match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notContaining (in Java code only, never a mapping key)
Docs
doesNotContain in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "doesNotContain": "error"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].doesNotContain.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "doesNotContain": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matches

Regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matches": "ORD-[0-9]+"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matches.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matches": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].doesNotMatch

Negative regex match.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Java DSL name
notMatching (in Java code only, never a mapping key)
Docs
doesNotMatch in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "doesNotMatch": ".*test.*"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].doesNotMatch.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "doesNotMatch": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].before

Date-time before the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
before in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "before": "now +1 days"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].after

Date-time after the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
after in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "after": "2026-01-01T00:00:00Z"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].equalToDateTime

Date-time equality with the given ISO-8601 instant or now-offset expression.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
equalToDateTime in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "equalToDateTime": "now"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].actualFormat

Option for before / after / equalToDateTime: format of the actual value.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "actualFormat": "dd/MM/yyyy"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].truncateExpected

Option for before / after / equalToDateTime: truncate the expected date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "truncateExpected": "first second of minute"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].truncateActual

Option for before / after / equalToDateTime: truncate the actual date-time to this point before comparing. One of the examples, in any case, with a space or an underscore between words. Checked only beside before, after or equalToDateTime, the matchers that read it.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "truncateActual": "first second of minute"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].applyTruncationLast

Option for before / after / equalToDateTime.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "applyTruncationLast": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].expectedOffset

Option for before / after / equalToDateTime.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "expectedOffset": 1
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].expectedOffsetUnit

Option for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "expectedOffsetUnit": "SECONDS"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].anything

Matches any value. The operand string is ignored.

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
any in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "anything": "anything"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].absent

The element must be absent. Canonically written as true; the operand value is ignored.

Type
any JSON
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
absent in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "absent": true
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].and

All nested matchers must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
and in the documentation
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].bodyPatterns.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "and": [
              {
                "contains": "order"
              },
              {
                "doesNotContain": "test"
              }
            ]
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].or

At least one nested matcher must match.

Type
[matcher]
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
or in the documentation
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].bodyPatterns.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "or": [
              {
                "equalTo": "GB"
              },
              {
                "equalTo": "IE"
              }
            ]
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].not

The nested matcher must not match.

Type
matcher
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
not in the documentation
Keys
The same keys as its enclosing matcher, request.multipartPatterns[].bodyPatterns.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "not": {
              "contains": "test"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).

Type
string
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesPathTemplate": "/orders/{orderId}"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].binaryEqualTo

Byte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "binaryEqualTo": "SGVsbG8="
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].binaryEqualTo.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "binaryEqualTo": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesXml

Traffic Parrot: XML match where element/attribute values may be regular expressions.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesXml": "<order><id>42</id></order>"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesXml.bodyFileName

Name of a file under __files whose content is the matcher's value, in place of an inline value.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesXml": {
              "bodyFileName": "requests/expected-order.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesJson

Traffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.

Type
string | object | array
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesJson in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesJson": {
              "orderId": 42
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesGraphQL

Traffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.

Type
string | object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesGraphQL in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesGraphQL": "{ order(id: 42) { status } }"
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesSwiftField

Traffic Parrot: match one field of a SWIFT MT message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesSwiftField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesSwiftField": {
              "field": "20",
              "matches": "REF[0-9]+"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesSwiftField.field

SWIFT MT field tag to read, for example 20 (transaction reference).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesSwiftField": {
              "field": "20"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesSwiftField": {
              "matches": "REF[0-9]+"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesSwiftField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesSwiftField": {
              "bodyFileName": "requests/mt103-match.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesFixField

Traffic Parrot: match one field of a FIX message.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesFixField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesFixField": {
              "field": "35",
              "matches": "D"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesFixField.field

FIX tag number to read, for example 35 (MsgType).

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesFixField": {
              "field": "35"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesFixField": {
              "matches": "D"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesFixField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesFixField": {
              "bodyFileName": "requests/fix-order-match.json"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.

Type
object
Required
No
Exclusive with
the other matchers: one matcher per matcher object, so add another entry, or use and / or, for more
Docs
matchesCicsField in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "field": "COMMAREA.ACCOUNT-NO",
              "equalTo": "1234567890"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.field

Path from the root of the request view, names exactly as written: ProgramName, COMMAREA.<copybook field>, MQCIH.<header field> or MQMD.UserIdentifier. A [n] after a name is a 0-based table index, as in COMMAREA.TXN-ENTRY[1].TXN-AMOUNT.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "field": "COMMAREA.ACCOUNT-NO"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.equalTo

The field's value equals this.

Type
string | number
Required
No
Docs
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "equalTo": "1234567890"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.matches

Regular expression the field's value must match.

Type
string
Required
No
Java DSL name
matching (in Java code only, never a mapping key)
Docs
matches in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "matches": "[0-9]{10}"
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.greaterThan

The field's numeric value is greater than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "greaterThan": 100
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.greaterThanOrEqualTo

The field's numeric value is greater than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "greaterThanOrEqualTo": 100
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.lessThan

The field's numeric value is less than this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "lessThan": 1000
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.lessThanOrEqualTo

The field's numeric value is less than or equal to this.

Type
string | number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "lessThanOrEqualTo": 1000
            }
          }
        ]
      }
    ]
  }
}

request.multipartPatterns[].bodyPatterns[].matchesCicsField.bodyFileName

Name of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "multipartPatterns": [
      {
        "bodyPatterns": [
          {
            "matchesCicsField": {
              "bodyFileName": "requests/cics-account-match.json"
            }
          }
        ]
      }
    ]
  }
}

request.customMatcher

Custom request matcher, e.g. name "requestMatchers" with a parameters.matchesScript Handlebars script, or parameters.matchesValidBearerToken {"oauth2Mock": "<name>"} to require a valid bearer token from a scaffolded OAuth2 mock. Several keys must all match.

Type
object
Required
No
Templates
May be a Handlebars template: see the helpers
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "customMatcher": {
      "name": "my-matcher",
      "parameters": {
        "threshold": 5
      }
    }
  }
}

request.customMatcher.name

Name the custom request matcher extension registers itself under.

Type
string
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "customMatcher": {
      "name": "my-matcher"
    }
  }
}

request.customMatcher.parameters

Parameters passed to the custom matcher. Their keys depend on the matcher.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "customMatcher": {
      "parameters": {
        "threshold": 5
      }
    }
  }
}

response

Response definition. Use at most one of body / jsonBody / base64Body / bodyFileName.

Type
object
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "jsonBody": {
      "orders": []
    }
  }
}

response.status

HTTP status code (default 200). gRPC mappings reuse this field for the gRPC status code, where 0 = OK.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "status": 200
  }
}

response.statusMessage

HTTP status message.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "statusMessage": "OK"
  }
}

response.body

Response body as text. May contain Handlebars templates when the response transformer is enabled.

Type
string
Required
No
Exclusive with
jsonBody, base64Body, bodyFileName: a mapping carries only one of them and this key
Templates
May be a Handlebars template: see the helpers
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "body": "{\"orderId\": 42, \"status\": \"open\"}"
  }
}

response.jsonBody

Response body as inline JSON (any JSON value).

Type
any JSON
Required
No
Exclusive with
body, base64Body, bodyFileName: a mapping carries only one of them and this key
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "jsonBody": {
      "orderId": 42,
      "status": "open"
    }
  }
}

response.base64Body

Response body as a Base64-encoded string (for binary content).

Type
string
Required
No
Exclusive with
body, jsonBody, bodyFileName: a mapping carries only one of them and this key
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "base64Body": "SGVsbG8gd29ybGQ="
  }
}

response.bodyFileName

Path to the file containing the response body, relative to the __files directory.

Type
string
Required
No
Exclusive with
body, jsonBody, base64Body: a mapping carries only one of them and this key
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "bodyFileName": "orders/open-orders.json"
  }
}

response.headers

Response headers: name to string value or array of string values.

Type
{name: string | array}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "headers": {
      "Content-Type": "application/json"
    }
  }
}

response.additionalProxyRequestHeaders

Extra headers added to the request when proxying.

Type
{name: string | array}
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "additionalProxyRequestHeaders": {
      "X-Forwarded-By": "traffic-parrot"
    }
  }
}

response.removeProxyRequestHeaders

Header names removed from the request when proxying.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "removeProxyRequestHeaders": [
      "Authorization"
    ]
  }
}

response.fixedDelayMilliseconds

Fixed delay in milliseconds before returning the response.

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "fixedDelayMilliseconds": 250
  }
}

response.delayDistribution

Random delay distribution, discriminated by type.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "type": "lognormal",
      "median": 80,
      "sigma": 0.4
    }
  }
}

response.delayDistribution.type

lognormal: a random delay drawn from a log-normal distribution. uniform: a random delay between lower and upper. fixed: the same delay every time.

Type
string
Required
Yes
Allowed values
"lognormal", "uniform", "fixed"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "type": "lognormal"
    }
  }
}

response.delayDistribution.median

Median delay in milliseconds. Only with type "lognormal".

Type
number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "median": 80
    }
  }
}

response.delayDistribution.sigma

Standard deviation of the underlying normal distribution. A larger value gives a longer tail of slow responses. Only with type "lognormal".

Type
number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "sigma": 0.4
    }
  }
}

response.delayDistribution.maxValue

Longest delay in milliseconds. A longer sampled delay is cut to this. Only with type "lognormal".

Type
number
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "maxValue": 2000
    }
  }
}

response.delayDistribution.lower

Shortest delay in milliseconds. Only with type "uniform".

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "lower": 50
    }
  }
}

response.delayDistribution.upper

Longest delay in milliseconds. Only with type "uniform".

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "upper": 150
    }
  }
}

response.delayDistribution.milliseconds

Delay in milliseconds. Only with type "fixed".

Type
integer
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "delayDistribution": {
      "milliseconds": 250
    }
  }
}

response.chunkedDribbleDelay

Dribble the response body to the client in chunks over totalDuration milliseconds.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "chunkedDribbleDelay": {
      "numberOfChunks": 5,
      "totalDuration": 1000
    }
  }
}

response.chunkedDribbleDelay.numberOfChunks

Number of chunks the response body is split into.

Type
integer
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "chunkedDribbleDelay": {
      "numberOfChunks": 5
    }
  }
}

response.chunkedDribbleDelay.totalDuration

Time in milliseconds over which the chunks are sent.

Type
integer
Required
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "chunkedDribbleDelay": {
      "totalDuration": 1000
    }
  }
}

response.fault

Fault to inject instead of a well-formed response. Values are case-sensitive, including the lowercase ms/s suffixes.

Type
string
Required
No
Allowed values
"CONNECTION_RESET_BY_PEER", "EMPTY_RESPONSE", "MALFORMED_RESPONSE_CHUNK", "RANDOM_DATA_THEN_CLOSE", "DRIP_BYTE_EVERY_100ms", "DRIP_BYTE_EVERY_1s", "DRIP_BYTE_EVERY_10s", "INCORRECT_SMALL_CONTENT_LENGTH", "CLOSE_CONNECTION_AFTER_HALF_RESPONSE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "fault": "CONNECTION_RESET_BY_PEER"
  }
}

response.proxyBaseUrl

Base URL to proxy matched requests to instead of serving a stubbed response.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "proxyBaseUrl": "https://api.example.com"
  }
}

response.proxyUrlPrefixToRemove

URL prefix removed from the request path before proxying.

Type
string
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "proxyUrlPrefixToRemove": "/proxy"
  }
}

response.transformers

Response transformer extension names to apply.

Type
[string]
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "transformers": [
      "response-template"
    ]
  }
}

response.transformerParameters

Parameters passed to the response transformers. Any key is accepted here.

Type
object
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "transformerParameters": {
      "discount": 10
    }
  }
}

response.fromConfiguredStub

Whether this response came from a configured stub. Traffic Parrot writes this flag; it is not needed when writing a mapping.

Type
boolean
Required
No
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "fromConfiguredStub": true
  }
}