IBM® MQ mapping keys

« Back to documentation home

Every key in IBM® MQ mapping files, from the schema ibm-mq-mapping.schema.json. The mapping explorer shows the same keys as a tree and checks a mapping against them.

One Traffic Parrot IBM MQ mapping: the request message to match and the response messages to send, as a JSON file in the ibm-mq-mappings directory (ibm-mq-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/ibm-mq-mapping.schema.json"
}

id

Unique identifier for the mapping. When Traffic Parrot saves a mapping it writes id, never mappingId.

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

Example in context:

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

mappingId

Older name for id. Traffic Parrot reads it when it loads the mapping, and writes id in its place when it saves the mapping.

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

Example in context:

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

mappingName

Do not write this key by hand. Traffic Parrot ignores any value written here: it sets the key to the file name when it loads the mapping, and writes it when it saves the mapping. The schema accepts it so that a saved mapping passes a check.

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

Example in context:

{
  "mappingName": "order-request.json"
}

priority

Priority of this mapping (default 5, lower number = higher priority). This schema accepts 1 or more.

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

Example in context:

{
  "priority": 1
}

request

Request matching criteria: which destination to listen on and which message bodies to match. There is no matcher for the queue manager: which queue manager a mapping uses comes from ibm-mq-connections.json in the files root.

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

Example in context:

{
  "request": {
    "destination": {
      "name": "ORDERS.REQUEST",
      "type": "QUEUE"
    },
    "bodyMatcher": {
      "contains": "orderId"
    }
  }
}

request.destination

A messaging destination: queue or topic name.

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

Example in context:

{
  "request": {
    "destination": {
      "name": "ORDERS.REQUEST",
      "type": "QUEUE"
    }
  }
}

request.destination.name

Queue or topic name.

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

Example in context:

{
  "request": {
    "destination": {
      "name": "ORDERS.REQUEST"
    }
  }
}

request.destination.type

Destination type.

Type
string
Required
Yes
Allowed values
"QUEUE", "TOPIC"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "destination": {
      "type": "QUEUE"
    }
  }
}

request.destination.skipDeclare

An AMQP setting that means nothing for IBM MQ. Traffic Parrot writes it, as false, every time it saves a mapping; it need not be written by hand.

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

Example in context:

{
  "request": {
    "destination": {
      "skipDeclare": false
    }
  }
}

request.destination.declareArguments

An AMQP setting that means nothing for IBM MQ. Traffic Parrot writes it, as an empty object, every time it saves a mapping; it need not be written by hand.

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

Example in context:

{
  "request": {
    "destination": {
      "declareArguments": {}
    }
  }
}

request.bodyMatcher

Single matcher object applied to the request message body (shared string-value matcher vocabulary; binaryEqualTo is additionally available here, matching the message bytes, as the binaryEqualTo key says). This top-level matcher is the one position where the expected value may be externalised as {"bodyFileName": "<file>"} under __files, read when the mapping loads; a file reference nested inside and/or/not is refused at load with an error naming the mapping file.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "contains": "orderId"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "equalTo": "ORD-42"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "equalTo": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.caseInsensitive

Option for equalTo.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "caseInsensitive": true
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "equalToJson": {
        "orderId": 42
      }
    }
  }
}

request.bodyMatcher.ignoreArrayOrder

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "ignoreArrayOrder": true
    }
  }
}

request.bodyMatcher.ignoreExtraElements

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "ignoreExtraElements": true
    }
  }
}

request.bodyMatcher.treatNullAsAbsent

Option for equalToJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "treatNullAsAbsent": true
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesJsonSchema": {
        "type": "object",
        "required": [
          "orderId"
        ]
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "schemaVersion": "V202012"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "equalToXml": "<order><id>42</id></order>"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "equalToXml": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.enablePlaceholders

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "enablePlaceholders": true
    }
  }
}

request.bodyMatcher.placeholderOpeningDelimiterRegex

Option for equalToXml.

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

Example in context:

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

request.bodyMatcher.placeholderClosingDelimiterRegex

Option for equalToXml.

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

Example in context:

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

request.bodyMatcher.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": {
    "bodyMatcher": {
      "exemptedComparisons": [
        "NAMESPACE_URI",
        "SCHEMA_LOCATION"
      ]
    }
  }
}

request.bodyMatcher.ignoreOrderOfSameNode

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "ignoreOrderOfSameNode": true
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "namespaceAwareness": "NONE"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesJsonPath": "$.orderId"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesXPath": "/order/id"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "xPathNamespaces": {
        "ord": "http://example.com/orders"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "contains": "orderId"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "contains": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "doesNotContain": "error"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "doesNotContain": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matches": "ORD-[0-9]+"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matches": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "doesNotMatch": ".*test.*"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "doesNotMatch": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "before": "now +1 days"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "after": "2026-01-01T00:00:00Z"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "equalToDateTime": "now"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "actualFormat": "dd/MM/yyyy"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "truncateExpected": "first second of minute"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "truncateActual": "first second of minute"
    }
  }
}

request.bodyMatcher.applyTruncationLast

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "applyTruncationLast": true
    }
  }
}

request.bodyMatcher.expectedOffset

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "expectedOffset": 1
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "expectedOffsetUnit": "SECONDS"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "anything": "anything"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "absent": true
    }
  }
}

request.bodyMatcher.and

All nested matchers must match. Nested matchers take inline values only.

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
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.and[].equalTo

Exact string equality.

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
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "equalTo": "ORD-42"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].caseInsensitive

Option for equalTo.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "caseInsensitive": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].equalToJson

Semantic JSON equality. Inline JSON value or a string containing JSON.

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": {
    "bodyMatcher": {
      "and": [
        {
          "equalToJson": {
            "orderId": 42
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].ignoreArrayOrder

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "ignoreArrayOrder": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].ignoreExtraElements

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "ignoreExtraElements": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].treatNullAsAbsent

Option for equalToJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "treatNullAsAbsent": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesJsonSchema

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

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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesJsonSchema": {
            "type": "object",
            "required": [
              "orderId"
            ]
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "schemaVersion": "V202012"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].equalToXml

Semantic XML equality.

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
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "equalToXml": "<order><id>42</id></order>"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].enablePlaceholders

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "enablePlaceholders": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].placeholderOpeningDelimiterRegex

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "placeholderOpeningDelimiterRegex": "\\[\\["
        }
      ]
    }
  }
}

request.bodyMatcher.and[].placeholderClosingDelimiterRegex

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "placeholderClosingDelimiterRegex": "\\]\\]"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "exemptedComparisons": [
            "NAMESPACE_URI",
            "SCHEMA_LOCATION"
          ]
        }
      ]
    }
  }
}

request.bodyMatcher.and[].ignoreOrderOfSameNode

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "ignoreOrderOfSameNode": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "namespaceAwareness": "NONE"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesJsonPath

JSONPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} 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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesJsonPath": "$.orderId"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesXPath

XPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} 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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesXPath": "/order/id"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "xPathNamespaces": {
            "ord": "http://example.com/orders"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].contains

Substring match.

Type
string
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": {
    "bodyMatcher": {
      "and": [
        {
          "contains": "orderId"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].doesNotContain

Negative substring match.

Type
string
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": {
    "bodyMatcher": {
      "and": [
        {
          "doesNotContain": "error"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matches

Regex match.

Type
string
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": {
    "bodyMatcher": {
      "and": [
        {
          "matches": "ORD-[0-9]+"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].doesNotMatch

Negative regex match.

Type
string
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": {
    "bodyMatcher": {
      "and": [
        {
          "doesNotMatch": ".*test.*"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "before": "now +1 days"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "after": "2026-01-01T00:00:00Z"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "equalToDateTime": "now"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "actualFormat": "dd/MM/yyyy"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "truncateExpected": "first second of minute"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "truncateActual": "first second of minute"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].applyTruncationLast

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "applyTruncationLast": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].expectedOffset

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "expectedOffset": 1
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "expectedOffsetUnit": "SECONDS"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "anything": "anything"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "absent": true
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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.bodyMatcher.and.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.and[].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.bodyMatcher.and.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.and[].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.bodyMatcher.and.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "not": {
            "contains": "test"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form).

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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesPathTemplate": "/orders/{orderId}"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesXml

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

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
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "matchesXml": "<order><id>42</id></order>"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesJson

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

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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesJson": {
            "orderId": 42
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesGraphQL

Traffic Parrot: GraphQL query match. A query string or an {"operationName": ..., "variables": ...} 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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesGraphQL": "{ order(id: 42) { status } }"
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesSwiftField": {
            "field": "20",
            "matches": "REF[0-9]+"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesSwiftField.field

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

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "matchesSwiftField": {
            "field": "20"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
Yes
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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesSwiftField": {
            "matches": "REF[0-9]+"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesFixField": {
            "field": "35",
            "matches": "D"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesFixField.field

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

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "matchesFixField": {
            "field": "35"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
Yes
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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesFixField": {
            "matches": "D"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "field": "COMMAREA.ACCOUNT-NO",
            "equalTo": "1234567890"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "field": "COMMAREA.ACCOUNT-NO"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "equalTo": "1234567890"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "matches": "[0-9]{10}"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "greaterThan": 100
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "greaterThanOrEqualTo": 100
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "lessThan": 1000
          }
        }
      ]
    }
  }
}

request.bodyMatcher.and[].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": {
    "bodyMatcher": {
      "and": [
        {
          "matchesCicsField": {
            "lessThanOrEqualTo": 1000
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or

At least one nested matcher must match. Nested matchers take inline values only.

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
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.or[].equalTo

Exact string equality.

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
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "equalTo": "ORD-42"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].caseInsensitive

Option for equalTo.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "caseInsensitive": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].equalToJson

Semantic JSON equality. Inline JSON value or a string containing JSON.

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": {
    "bodyMatcher": {
      "or": [
        {
          "equalToJson": {
            "orderId": 42
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].ignoreArrayOrder

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "ignoreArrayOrder": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].ignoreExtraElements

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "ignoreExtraElements": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].treatNullAsAbsent

Option for equalToJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "treatNullAsAbsent": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesJsonSchema

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

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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesJsonSchema": {
            "type": "object",
            "required": [
              "orderId"
            ]
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "schemaVersion": "V202012"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].equalToXml

Semantic XML equality.

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
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "equalToXml": "<order><id>42</id></order>"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].enablePlaceholders

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "enablePlaceholders": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].placeholderOpeningDelimiterRegex

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "placeholderOpeningDelimiterRegex": "\\[\\["
        }
      ]
    }
  }
}

request.bodyMatcher.or[].placeholderClosingDelimiterRegex

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "placeholderClosingDelimiterRegex": "\\]\\]"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "exemptedComparisons": [
            "NAMESPACE_URI",
            "SCHEMA_LOCATION"
          ]
        }
      ]
    }
  }
}

request.bodyMatcher.or[].ignoreOrderOfSameNode

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "ignoreOrderOfSameNode": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "namespaceAwareness": "NONE"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesJsonPath

JSONPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} 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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesJsonPath": "$.orderId"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesXPath

XPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} 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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesXPath": "/order/id"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "xPathNamespaces": {
            "ord": "http://example.com/orders"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].contains

Substring match.

Type
string
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": {
    "bodyMatcher": {
      "or": [
        {
          "contains": "orderId"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].doesNotContain

Negative substring match.

Type
string
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": {
    "bodyMatcher": {
      "or": [
        {
          "doesNotContain": "error"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matches

Regex match.

Type
string
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": {
    "bodyMatcher": {
      "or": [
        {
          "matches": "ORD-[0-9]+"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].doesNotMatch

Negative regex match.

Type
string
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": {
    "bodyMatcher": {
      "or": [
        {
          "doesNotMatch": ".*test.*"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "before": "now +1 days"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "after": "2026-01-01T00:00:00Z"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "equalToDateTime": "now"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "actualFormat": "dd/MM/yyyy"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "truncateExpected": "first second of minute"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "truncateActual": "first second of minute"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].applyTruncationLast

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "applyTruncationLast": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].expectedOffset

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "expectedOffset": 1
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "expectedOffsetUnit": "SECONDS"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "anything": "anything"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "absent": true
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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.bodyMatcher.or.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.or[].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.bodyMatcher.or.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.or[].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.bodyMatcher.or.
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "not": {
            "contains": "test"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form).

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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesPathTemplate": "/orders/{orderId}"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesXml

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

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
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "matchesXml": "<order><id>42</id></order>"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesJson

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

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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesJson": {
            "orderId": 42
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesGraphQL

Traffic Parrot: GraphQL query match. A query string or an {"operationName": ..., "variables": ...} 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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesGraphQL": "{ order(id: 42) { status } }"
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesSwiftField": {
            "field": "20",
            "matches": "REF[0-9]+"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesSwiftField.field

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

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "matchesSwiftField": {
            "field": "20"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
Yes
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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesSwiftField": {
            "matches": "REF[0-9]+"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesFixField": {
            "field": "35",
            "matches": "D"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesFixField.field

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

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "matchesFixField": {
            "field": "35"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
Yes
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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesFixField": {
            "matches": "D"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "field": "COMMAREA.ACCOUNT-NO",
            "equalTo": "1234567890"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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
Yes
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "field": "COMMAREA.ACCOUNT-NO"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "equalTo": "1234567890"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "matches": "[0-9]{10}"
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "greaterThan": 100
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "greaterThanOrEqualTo": 100
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "lessThan": 1000
          }
        }
      ]
    }
  }
}

request.bodyMatcher.or[].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": {
    "bodyMatcher": {
      "or": [
        {
          "matchesCicsField": {
            "lessThanOrEqualTo": 1000
          }
        }
      ]
    }
  }
}

request.bodyMatcher.not

The nested matcher must not match. Nested matchers take inline values only.

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
Matchers
equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.equalTo

Exact string equality.

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
equalTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "equalTo": "ORD-42"
      }
    }
  }
}

request.bodyMatcher.not.caseInsensitive

Option for equalTo.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "caseInsensitive": true
      }
    }
  }
}

request.bodyMatcher.not.equalToJson

Semantic JSON equality. Inline JSON value or a string containing JSON.

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": {
    "bodyMatcher": {
      "not": {
        "equalToJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.bodyMatcher.not.ignoreArrayOrder

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "ignoreArrayOrder": true
      }
    }
  }
}

request.bodyMatcher.not.ignoreExtraElements

Option for equalToJson / matchesJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "ignoreExtraElements": true
      }
    }
  }
}

request.bodyMatcher.not.treatNullAsAbsent

Option for equalToJson.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "treatNullAsAbsent": true
      }
    }
  }
}

request.bodyMatcher.not.matchesJsonSchema

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

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": {
    "bodyMatcher": {
      "not": {
        "matchesJsonSchema": {
          "type": "object",
          "required": [
            "orderId"
          ]
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "schemaVersion": "V202012"
      }
    }
  }
}

request.bodyMatcher.not.equalToXml

Semantic XML equality.

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
equalToXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.enablePlaceholders

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "enablePlaceholders": true
      }
    }
  }
}

request.bodyMatcher.not.placeholderOpeningDelimiterRegex

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "placeholderOpeningDelimiterRegex": "\\[\\["
      }
    }
  }
}

request.bodyMatcher.not.placeholderClosingDelimiterRegex

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "placeholderClosingDelimiterRegex": "\\]\\]"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "exemptedComparisons": [
          "NAMESPACE_URI",
          "SCHEMA_LOCATION"
        ]
      }
    }
  }
}

request.bodyMatcher.not.ignoreOrderOfSameNode

Option for equalToXml.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "ignoreOrderOfSameNode": true
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "namespaceAwareness": "NONE"
      }
    }
  }
}

request.bodyMatcher.not.matchesJsonPath

JSONPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} 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": {
    "bodyMatcher": {
      "not": {
        "matchesJsonPath": "$.orderId"
      }
    }
  }
}

request.bodyMatcher.not.matchesXPath

XPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} 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": {
    "bodyMatcher": {
      "not": {
        "matchesXPath": "/order/id"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "xPathNamespaces": {
          "ord": "http://example.com/orders"
        }
      }
    }
  }
}

request.bodyMatcher.not.contains

Substring match.

Type
string
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": {
    "bodyMatcher": {
      "not": {
        "contains": "orderId"
      }
    }
  }
}

request.bodyMatcher.not.doesNotContain

Negative substring match.

Type
string
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": {
    "bodyMatcher": {
      "not": {
        "doesNotContain": "error"
      }
    }
  }
}

request.bodyMatcher.not.matches

Regex match.

Type
string
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": {
    "bodyMatcher": {
      "not": {
        "matches": "ORD-[0-9]+"
      }
    }
  }
}

request.bodyMatcher.not.doesNotMatch

Negative regex match.

Type
string
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": {
    "bodyMatcher": {
      "not": {
        "doesNotMatch": ".*test.*"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "before": "now +1 days"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "after": "2026-01-01T00:00:00Z"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "equalToDateTime": "now"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "actualFormat": "dd/MM/yyyy"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "truncateExpected": "first second of minute"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "truncateActual": "first second of minute"
      }
    }
  }
}

request.bodyMatcher.not.applyTruncationLast

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "applyTruncationLast": true
      }
    }
  }
}

request.bodyMatcher.not.expectedOffset

Option for before / after / equalToDateTime.

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "expectedOffset": 1
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "expectedOffsetUnit": "SECONDS"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "anything": "anything"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "absent": true
      }
    }
  }
}

request.bodyMatcher.not.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.bodyMatcher.not.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.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.bodyMatcher.not.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.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.bodyMatcher.not.
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form).

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": {
    "bodyMatcher": {
      "not": {
        "matchesPathTemplate": "/orders/{orderId}"
      }
    }
  }
}

request.bodyMatcher.not.matchesXml

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

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
matchesXml in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.matchesJson

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

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": {
    "bodyMatcher": {
      "not": {
        "matchesJson": {
          "orderId": 42
        }
      }
    }
  }
}

request.bodyMatcher.not.matchesGraphQL

Traffic Parrot: GraphQL query match. A query string or an {"operationName": ..., "variables": ...} 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": {
    "bodyMatcher": {
      "not": {
        "matchesGraphQL": "{ order(id: 42) { status } }"
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesSwiftField": {
          "field": "20",
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.bodyMatcher.not.matchesSwiftField.field

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

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "matchesSwiftField": {
          "field": "20"
        }
      }
    }
  }
}

request.bodyMatcher.not.matchesSwiftField.matches

Regular expression the field's value must match.

Type
string
Required
Yes
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": {
    "bodyMatcher": {
      "not": {
        "matchesSwiftField": {
          "matches": "REF[0-9]+"
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesFixField": {
          "field": "35",
          "matches": "D"
        }
      }
    }
  }
}

request.bodyMatcher.not.matchesFixField.field

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

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

Example in context:

{
  "request": {
    "bodyMatcher": {
      "not": {
        "matchesFixField": {
          "field": "35"
        }
      }
    }
  }
}

request.bodyMatcher.not.matchesFixField.matches

Regular expression the tag's value must match.

Type
string
Required
Yes
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": {
    "bodyMatcher": {
      "not": {
        "matchesFixField": {
          "matches": "D"
        }
      }
    }
  }
}

request.bodyMatcher.not.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "field": "COMMAREA.ACCOUNT-NO",
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.bodyMatcher.not.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
Yes
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "equalTo": "1234567890"
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "matches": "[0-9]{10}"
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "greaterThan": 100
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "greaterThanOrEqualTo": 100
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "lessThan": 1000
        }
      }
    }
  }
}

request.bodyMatcher.not.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": {
    "bodyMatcher": {
      "not": {
        "matchesCicsField": {
          "lessThanOrEqualTo": 1000
        }
      }
    }
  }
}

request.bodyMatcher.matchesPathTemplate

RFC 6570 path template match (string-value sub-matcher form).

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": {
    "bodyMatcher": {
      "matchesPathTemplate": "/orders/{orderId}"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesXml": "<order><id>42</id></order>"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesXml": {
        "bodyFileName": "requests/expected-order.json"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesJson": {
        "orderId": 42
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesGraphQL": "{ order(id: 42) { status } }"
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesSwiftField": {
        "field": "20",
        "matches": "REF[0-9]+"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesSwiftField": {
        "field": "20"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesSwiftField": {
        "matches": "REF[0-9]+"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesSwiftField": {
        "bodyFileName": "requests/mt103-match.json"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesFixField": {
        "field": "35",
        "matches": "D"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesFixField": {
        "field": "35"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesFixField": {
        "matches": "D"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesFixField": {
        "bodyFileName": "requests/fix-order-match.json"
      }
    }
  }
}

request.bodyMatcher.matchesCicsField

Traffic Parrot: match one field of a CICS bridge request (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
matcher
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
Matchers
field, bodyFileName
Explorer
Open this key in the mapping explorer

Example in context:

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

request.bodyMatcher.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
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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "field": "COMMAREA.ACCOUNT-NO"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "equalTo": "1234567890"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "matches": "[0-9]{10}"
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "greaterThan": 100
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "greaterThanOrEqualTo": 100
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "lessThan": 1000
      }
    }
  }
}

request.bodyMatcher.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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "lessThanOrEqualTo": 1000
      }
    }
  }
}

request.bodyMatcher.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
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": {
    "bodyMatcher": {
      "matchesCicsField": {
        "bodyFileName": "requests/cics-account-match.json"
      }
    }
  }
}

request.bodyMatcher.binaryEqualTo

Byte-for-byte equality of the Base64-decoded value with the message bytes as Traffic Parrot read them: the raw bytes of an MQFMT_NONE or RFH-wrapped body, and for an MQFMT_STRING body the UTF-8 encoding of the decoded text. Valid as the top-level bodyMatcher only, and inline only: a {"bodyFileName": ...} reference on it is refused when the mapping loads, so the schema does not offer the file form here.

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
binaryEqualTo in the documentation
Explorer
Open this key in the mapping explorer

Example in context:

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

response

DEPRECATED single-response form: use responses instead. Traffic Parrot still reads it and adds it to the responses list, and writes responses alone when it saves the mapping.

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

Example in context:

{
  "response": {
    "destination": {
      "name": "ORDERS.RESPONSE",
      "type": "QUEUE"
    },
    "text": "{\"status\": \"accepted\"}",
    "format": "MQFMT_STRING"
  }
}

response.destination

A messaging destination: queue or topic name.

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

Example in context:

{
  "response": {
    "destination": {
      "name": "ORDERS.RESPONSE",
      "type": "QUEUE"
    }
  }
}

response.destination.name

Queue or topic name.

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

Example in context:

{
  "response": {
    "destination": {
      "name": "ORDERS.REQUEST"
    }
  }
}

response.destination.type

Destination type.

Type
string
Required
Yes
Allowed values
"QUEUE", "TOPIC"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "destination": {
      "type": "QUEUE"
    }
  }
}

response.destination.skipDeclare

An AMQP setting that means nothing for IBM MQ. Traffic Parrot writes it, as false, every time it saves a mapping; it need not be written by hand.

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

Example in context:

{
  "response": {
    "destination": {
      "skipDeclare": false
    }
  }
}

response.destination.declareArguments

An AMQP setting that means nothing for IBM MQ. Traffic Parrot writes it, as an empty object, every time it saves a mapping; it need not be written by hand.

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

Example in context:

{
  "response": {
    "destination": {
      "declareArguments": {}
    }
  }
}

response.text

Response message body. May contain Handlebars templates. For the binary formats (MQFMT_RF_HEADER_1/2, MQFMT_NONE) this is the printable-characters encoding of the bytes to write. A mapping whose transformer builds the whole message may omit it. Mutually exclusive with bodyFileName.

Type
string
Required
No
Templates
May be a Handlebars template: see the helpers
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "text": "{\"status\": \"accepted\"}"
  }
}

response.bodyFileName

Response message body read from this file under the __files directory instead of from an inline text. Supported only with the MQFMT_STRING format: the other three formats write printable-characters-decoded bytes, and a file-backed binary body is rejected at load. Mutually exclusive with text.

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

Example in context:

{
  "response": {
    "bodyFileName": "responses/order-accepted.json"
  }
}

response.format

MQ message format (default MQFMT_STRING). MQFMT_RF_HEADER_1/2 and MQFMT_NONE write the text as printable-characters-decoded bytes.

Type
string
Required
No
Allowed values
"MQFMT_STRING", "MQFMT_RF_HEADER_1", "MQFMT_RF_HEADER_2", "MQFMT_NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "format": "MQFMT_STRING"
  }
}

response.characterSet

Character set (CCSID) used when writing an MQFMT_STRING body (default UTF_8).

Type
string
Required
No
Allowed values
"UTF_8", "UNICODE", "ASCII_850", "ISO_8859_1", "EBCDIC_US"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "characterSet": "UTF_8"
  }
}

response.fixedDelayMilliseconds

Fixed delay in milliseconds before sending this response (default 0). This schema accepts 0 or more.

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

Example in context:

{
  "response": {
    "fixedDelayMilliseconds": 250
  }
}

response.ibmMqResponseTransformerClassName

Fully-qualified class name of an SDK response transformer, or the NO_TRANSFORMER sentinel.

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

Example in context:

{
  "response": {
    "ibmMqResponseTransformerClassName": "com.example.OrderResponseTransformer"
  }
}

response.destinationLookup

How the response destination is resolved (default: use the request message's replyTo queue when present, otherwise the mapping's response destination). null is accepted only because Traffic Parrot writes it when it saves a mapping; it need not be written by hand.

Type
any JSON
Required
No
Allowed values
null, "USE_REQUEST_MESSAGE_REPLY_TO_QUEUE_NAME_OR_MAPPING_RESPONSE_DESTINATION", "USE_MAPPING_RESPONSE_DESTINATION"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "response": {
    "destinationLookup": "USE_MAPPING_RESPONSE_DESTINATION"
  }
}

response.replyToQueueManagerName

Reply-to queue manager name set on the response message.

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

Example in context:

{
  "response": {
    "replyToQueueManagerName": "QM1"
  }
}

response.replyToQueueName

Reply-to queue name set on the response message.

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

Example in context:

{
  "response": {
    "replyToQueueName": "ORDERS.REPLY"
  }
}

response.never-serialized-field

Leave this key out: Traffic Parrot never writes it, and null is the only value it accepts.

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

Example in context:

{
  "response": {
    "never-serialized-field": null
  }
}

responses

Responses to send when the request matches, in order. A mapping with no response (and no responses) consumes the request message without replying, which Traffic Parrot supports.

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

Example in context:

{
  "responses": [
    {
      "destination": {
        "name": "ORDERS.RESPONSE",
        "type": "QUEUE"
      },
      "text": "{\"status\": \"accepted\"}",
      "format": "MQFMT_STRING"
    }
  ]
}

responses[].destination

A messaging destination: queue or topic name.

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

Example in context:

{
  "responses": [
    {
      "destination": {
        "name": "ORDERS.RESPONSE",
        "type": "QUEUE"
      }
    }
  ]
}

responses[].destination.name

Queue or topic name.

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

Example in context:

{
  "responses": [
    {
      "destination": {
        "name": "ORDERS.REQUEST"
      }
    }
  ]
}

responses[].destination.type

Destination type.

Type
string
Required
Yes
Allowed values
"QUEUE", "TOPIC"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "responses": [
    {
      "destination": {
        "type": "QUEUE"
      }
    }
  ]
}

responses[].destination.skipDeclare

An AMQP setting that means nothing for IBM MQ. Traffic Parrot writes it, as false, every time it saves a mapping; it need not be written by hand.

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

Example in context:

{
  "responses": [
    {
      "destination": {
        "skipDeclare": false
      }
    }
  ]
}

responses[].destination.declareArguments

An AMQP setting that means nothing for IBM MQ. Traffic Parrot writes it, as an empty object, every time it saves a mapping; it need not be written by hand.

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

Example in context:

{
  "responses": [
    {
      "destination": {
        "declareArguments": {}
      }
    }
  ]
}

responses[].text

Response message body. May contain Handlebars templates. For the binary formats (MQFMT_RF_HEADER_1/2, MQFMT_NONE) this is the printable-characters encoding of the bytes to write. A mapping whose transformer builds the whole message may omit it. Mutually exclusive with bodyFileName.

Type
string
Required
No
Templates
May be a Handlebars template: see the helpers
Explorer
Open this key in the mapping explorer

Example in context:

{
  "responses": [
    {
      "text": "{\"status\": \"accepted\"}"
    }
  ]
}

responses[].bodyFileName

Response message body read from this file under the __files directory instead of from an inline text. Supported only with the MQFMT_STRING format: the other three formats write printable-characters-decoded bytes, and a file-backed binary body is rejected at load. Mutually exclusive with text.

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

Example in context:

{
  "responses": [
    {
      "bodyFileName": "responses/order-accepted.json"
    }
  ]
}

responses[].format

MQ message format (default MQFMT_STRING). MQFMT_RF_HEADER_1/2 and MQFMT_NONE write the text as printable-characters-decoded bytes.

Type
string
Required
No
Allowed values
"MQFMT_STRING", "MQFMT_RF_HEADER_1", "MQFMT_RF_HEADER_2", "MQFMT_NONE"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "responses": [
    {
      "format": "MQFMT_STRING"
    }
  ]
}

responses[].characterSet

Character set (CCSID) used when writing an MQFMT_STRING body (default UTF_8).

Type
string
Required
No
Allowed values
"UTF_8", "UNICODE", "ASCII_850", "ISO_8859_1", "EBCDIC_US"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "responses": [
    {
      "characterSet": "UTF_8"
    }
  ]
}

responses[].fixedDelayMilliseconds

Fixed delay in milliseconds before sending this response (default 0). This schema accepts 0 or more.

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

Example in context:

{
  "responses": [
    {
      "fixedDelayMilliseconds": 250
    }
  ]
}

responses[].ibmMqResponseTransformerClassName

Fully-qualified class name of an SDK response transformer, or the NO_TRANSFORMER sentinel.

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

Example in context:

{
  "responses": [
    {
      "ibmMqResponseTransformerClassName": "com.example.OrderResponseTransformer"
    }
  ]
}

responses[].destinationLookup

How the response destination is resolved (default: use the request message's replyTo queue when present, otherwise the mapping's response destination). null is accepted only because Traffic Parrot writes it when it saves a mapping; it need not be written by hand.

Type
any JSON
Required
No
Allowed values
null, "USE_REQUEST_MESSAGE_REPLY_TO_QUEUE_NAME_OR_MAPPING_RESPONSE_DESTINATION", "USE_MAPPING_RESPONSE_DESTINATION"
Explorer
Open this key in the mapping explorer

Example in context:

{
  "responses": [
    {
      "destinationLookup": "USE_MAPPING_RESPONSE_DESTINATION"
    }
  ]
}

responses[].replyToQueueManagerName

Reply-to queue manager name set on the response message.

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

Example in context:

{
  "responses": [
    {
      "replyToQueueManagerName": "QM1"
    }
  ]
}

responses[].replyToQueueName

Reply-to queue name set on the response message.

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

Example in context:

{
  "responses": [
    {
      "replyToQueueName": "ORDERS.REPLY"
    }
  ]
}

responses[].never-serialized-field

Leave this key out: Traffic Parrot never writes it, and null is the only value it accepts.

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

Example in context:

{
  "responses": [
    {
      "never-serialized-field": null
    }
  ]
}

receiveThreads

Number of threads receiving from the request destination (default 1). This schema accepts 1 or more.

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

Example in context:

{
  "receiveThreads": 1
}

sendThreads

Number of threads sending responses (default 1). This schema accepts 1 or more.

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

Example in context:

{
  "sendThreads": 1
}

maxMessagesInProgress

Maximum number of messages processed concurrently. Unlimited when absent. This schema accepts 1 or more.

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

Example in context:

{
  "maxMessagesInProgress": 100
}