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.
$schemaReference to this schema for IDE support. Traffic Parrot ignores it.
stringExample in context:
{
"$schema": "http://localhost:8080/schemas/ibm-mq-mapping.schema.json"
}
idUnique identifier for the mapping. When Traffic Parrot saves a mapping it writes id, never mappingId.
stringExample in context:
{
"id": "0b1d4c39-6c2f-4e0e-9a51-8f2a3c5d7e90"
}
mappingIdOlder name for id. Traffic Parrot reads it when it loads the mapping, and writes id in its place when it saves the mapping.
stringExample in context:
{
"mappingId": "0b1d4c39-6c2f-4e0e-9a51-8f2a3c5d7e90"
}
mappingNameDo 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.
stringExample in context:
{
"mappingName": "order-request.json"
}
priorityPriority of this mapping (default 5, lower number = higher priority). This schema accepts 1 or more.
integerExample in context:
{
"priority": 1
}
requestRequest 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.
objectExample in context:
{
"request": {
"destination": {
"name": "ORDERS.REQUEST",
"type": "QUEUE"
},
"bodyMatcher": {
"contains": "orderId"
}
}
}
request.destinationA messaging destination: queue or topic name.
objectExample in context:
{
"request": {
"destination": {
"name": "ORDERS.REQUEST",
"type": "QUEUE"
}
}
}
request.destination.nameQueue or topic name.
stringExample in context:
{
"request": {
"destination": {
"name": "ORDERS.REQUEST"
}
}
}
request.destination.typeDestination type.
string"QUEUE", "TOPIC"Example in context:
{
"request": {
"destination": {
"type": "QUEUE"
}
}
}
request.destination.skipDeclareAn 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.
booleanExample in context:
{
"request": {
"destination": {
"skipDeclare": false
}
}
}
request.destination.declareArgumentsAn 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.
objectExample in context:
{
"request": {
"destination": {
"declareArguments": {}
}
}
}
request.bodyMatcherSingle 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.
matcherequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, binaryEqualToExample in context:
{
"request": {
"bodyMatcher": {
"contains": "orderId"
}
}
}
request.bodyMatcher.equalToExact string equality.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"equalTo": "ORD-42"
}
}
}
request.bodyMatcher.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"caseInsensitive": true
}
}
}
request.bodyMatcher.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"equalToJson": {
"orderId": 42
}
}
}
}
request.bodyMatcher.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"ignoreArrayOrder": true
}
}
}
request.bodyMatcher.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"ignoreExtraElements": true
}
}
}
request.bodyMatcher.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"treatNullAsAbsent": true
}
}
}
request.bodyMatcher.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
request.bodyMatcher.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"bodyMatcher": {
"schemaVersion": "V202012"
}
}
}
request.bodyMatcher.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
request.bodyMatcher.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"enablePlaceholders": true
}
}
}
request.bodyMatcher.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
request.bodyMatcher.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
request.bodyMatcher.exemptedComparisonsOption for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.
[string]Example in context:
{
"request": {
"bodyMatcher": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
request.bodyMatcher.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"ignoreOrderOfSameNode": true
}
}
}
request.bodyMatcher.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"bodyMatcher": {
"namespaceAwareness": "NONE"
}
}
}
request.bodyMatcher.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesJsonPath": "$.orderId"
}
}
}
request.bodyMatcher.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesXPath": "/order/id"
}
}
}
request.bodyMatcher.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"bodyMatcher": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
request.bodyMatcher.containsSubstring match.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"contains": "orderId"
}
}
}
request.bodyMatcher.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"doesNotContain": "error"
}
}
}
request.bodyMatcher.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.matchesRegex match.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"matches": "ORD-[0-9]+"
}
}
}
request.bodyMatcher.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"doesNotMatch": ".*test.*"
}
}
}
request.bodyMatcher.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"before": "now +1 days"
}
}
}
request.bodyMatcher.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"after": "2026-01-01T00:00:00Z"
}
}
}
request.bodyMatcher.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"equalToDateTime": "now"
}
}
}
request.bodyMatcher.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"actualFormat": "dd/MM/yyyy"
}
}
}
request.bodyMatcher.truncateExpectedOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"truncateExpected": "first second of minute"
}
}
}
request.bodyMatcher.truncateActualOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"truncateActual": "first second of minute"
}
}
}
request.bodyMatcher.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"applyTruncationLast": true
}
}
}
request.bodyMatcher.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"bodyMatcher": {
"expectedOffset": 1
}
}
}
request.bodyMatcher.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"bodyMatcher": {
"expectedOffsetUnit": "SECONDS"
}
}
}
request.bodyMatcher.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"bodyMatcher": {
"anything": "anything"
}
}
}
request.bodyMatcher.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"bodyMatcher": {
"absent": true
}
}
}
request.bodyMatcher.andAll nested matchers must match. Nested matchers take inline values only.
[matcher]equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
request.bodyMatcher.and[].equalToExact string equality.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"equalTo": "ORD-42"
}
]
}
}
}
request.bodyMatcher.and[].caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"caseInsensitive": true
}
]
}
}
}
request.bodyMatcher.and[].equalToJsonSemantic JSON equality. Inline JSON value or a string containing JSON.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"equalToJson": {
"orderId": 42
}
}
]
}
}
}
request.bodyMatcher.and[].ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"ignoreArrayOrder": true
}
]
}
}
}
request.bodyMatcher.and[].ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"ignoreExtraElements": true
}
]
}
}
}
request.bodyMatcher.and[].treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"treatNullAsAbsent": true
}
]
}
}
}
request.bodyMatcher.and[].matchesJsonSchemaValue must validate against the given JSON Schema (inline object or string).
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
]
}
}
}
request.bodyMatcher.and[].schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"schemaVersion": "V202012"
}
]
}
}
}
request.bodyMatcher.and[].equalToXmlSemantic XML equality.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"equalToXml": "<order><id>42</id></order>"
}
]
}
}
}
request.bodyMatcher.and[].enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"enablePlaceholders": true
}
]
}
}
}
request.bodyMatcher.and[].placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"placeholderOpeningDelimiterRegex": "\\[\\["
}
]
}
}
}
request.bodyMatcher.and[].placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"placeholderClosingDelimiterRegex": "\\]\\]"
}
]
}
}
}
request.bodyMatcher.and[].exemptedComparisonsOption for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.
[string]Example in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
]
}
}
}
request.bodyMatcher.and[].ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"ignoreOrderOfSameNode": true
}
]
}
}
}
request.bodyMatcher.and[].namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"namespaceAwareness": "NONE"
}
]
}
}
}
request.bodyMatcher.and[].matchesJsonPathJSONPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesJsonPath": "$.orderId"
}
]
}
}
}
request.bodyMatcher.and[].matchesXPathXPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesXPath": "/order/id"
}
]
}
}
}
request.bodyMatcher.and[].xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
]
}
}
}
request.bodyMatcher.and[].containsSubstring match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"contains": "orderId"
}
]
}
}
}
request.bodyMatcher.and[].doesNotContainNegative substring match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"doesNotContain": "error"
}
]
}
}
}
request.bodyMatcher.and[].matchesRegex match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matches": "ORD-[0-9]+"
}
]
}
}
}
request.bodyMatcher.and[].doesNotMatchNegative regex match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"doesNotMatch": ".*test.*"
}
]
}
}
}
request.bodyMatcher.and[].beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"before": "now +1 days"
}
]
}
}
}
request.bodyMatcher.and[].afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"after": "2026-01-01T00:00:00Z"
}
]
}
}
}
request.bodyMatcher.and[].equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"equalToDateTime": "now"
}
]
}
}
}
request.bodyMatcher.and[].actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"actualFormat": "dd/MM/yyyy"
}
]
}
}
}
request.bodyMatcher.and[].truncateExpectedOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"truncateExpected": "first second of minute"
}
]
}
}
}
request.bodyMatcher.and[].truncateActualOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"truncateActual": "first second of minute"
}
]
}
}
}
request.bodyMatcher.and[].applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"applyTruncationLast": true
}
]
}
}
}
request.bodyMatcher.and[].expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"expectedOffset": 1
}
]
}
}
}
request.bodyMatcher.and[].expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"expectedOffsetUnit": "SECONDS"
}
]
}
}
}
request.bodyMatcher.and[].anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"anything": "anything"
}
]
}
}
}
request.bodyMatcher.and[].absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"absent": true
}
]
}
}
}
request.bodyMatcher.and[].andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
]
}
}
}
request.bodyMatcher.and[].orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
]
}
}
}
request.bodyMatcher.and[].notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"not": {
"contains": "test"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form).
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesPathTemplate": "/orders/{orderId}"
}
]
}
}
}
request.bodyMatcher.and[].matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesXml": "<order><id>42</id></order>"
}
]
}
}
}
request.bodyMatcher.and[].matchesJsonTraffic Parrot: JSON match where values may be regular expressions. Inline JSON value or a string containing JSON.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesJson": {
"orderId": 42
}
}
]
}
}
}
request.bodyMatcher.and[].matchesGraphQLTraffic Parrot: GraphQL query match. A query string or an {"operationName": ..., "variables": ...} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesGraphQL": "{ order(id: 42) { status } }"
}
]
}
}
}
request.bodyMatcher.and[].matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesSwiftField": {
"field": "20"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesFixField": {
"field": "35"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesFixField": {
"matches": "D"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsFieldTraffic 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.
objectExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.fieldPath 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"equalTo": "1234567890"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"greaterThan": 100
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"lessThan": 1000
}
}
]
}
}
}
request.bodyMatcher.and[].matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"and": [
{
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
]
}
}
}
request.bodyMatcher.orAt least one nested matcher must match. Nested matchers take inline values only.
[matcher]equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
request.bodyMatcher.or[].equalToExact string equality.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"equalTo": "ORD-42"
}
]
}
}
}
request.bodyMatcher.or[].caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"caseInsensitive": true
}
]
}
}
}
request.bodyMatcher.or[].equalToJsonSemantic JSON equality. Inline JSON value or a string containing JSON.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"equalToJson": {
"orderId": 42
}
}
]
}
}
}
request.bodyMatcher.or[].ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"ignoreArrayOrder": true
}
]
}
}
}
request.bodyMatcher.or[].ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"ignoreExtraElements": true
}
]
}
}
}
request.bodyMatcher.or[].treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"treatNullAsAbsent": true
}
]
}
}
}
request.bodyMatcher.or[].matchesJsonSchemaValue must validate against the given JSON Schema (inline object or string).
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
]
}
}
}
request.bodyMatcher.or[].schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"schemaVersion": "V202012"
}
]
}
}
}
request.bodyMatcher.or[].equalToXmlSemantic XML equality.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"equalToXml": "<order><id>42</id></order>"
}
]
}
}
}
request.bodyMatcher.or[].enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"enablePlaceholders": true
}
]
}
}
}
request.bodyMatcher.or[].placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"placeholderOpeningDelimiterRegex": "\\[\\["
}
]
}
}
}
request.bodyMatcher.or[].placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"placeholderClosingDelimiterRegex": "\\]\\]"
}
]
}
}
}
request.bodyMatcher.or[].exemptedComparisonsOption for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.
[string]Example in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
]
}
}
}
request.bodyMatcher.or[].ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"ignoreOrderOfSameNode": true
}
]
}
}
}
request.bodyMatcher.or[].namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"namespaceAwareness": "NONE"
}
]
}
}
}
request.bodyMatcher.or[].matchesJsonPathJSONPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesJsonPath": "$.orderId"
}
]
}
}
}
request.bodyMatcher.or[].matchesXPathXPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesXPath": "/order/id"
}
]
}
}
}
request.bodyMatcher.or[].xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
]
}
}
}
request.bodyMatcher.or[].containsSubstring match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"contains": "orderId"
}
]
}
}
}
request.bodyMatcher.or[].doesNotContainNegative substring match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"doesNotContain": "error"
}
]
}
}
}
request.bodyMatcher.or[].matchesRegex match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matches": "ORD-[0-9]+"
}
]
}
}
}
request.bodyMatcher.or[].doesNotMatchNegative regex match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"doesNotMatch": ".*test.*"
}
]
}
}
}
request.bodyMatcher.or[].beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"before": "now +1 days"
}
]
}
}
}
request.bodyMatcher.or[].afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"after": "2026-01-01T00:00:00Z"
}
]
}
}
}
request.bodyMatcher.or[].equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"equalToDateTime": "now"
}
]
}
}
}
request.bodyMatcher.or[].actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"actualFormat": "dd/MM/yyyy"
}
]
}
}
}
request.bodyMatcher.or[].truncateExpectedOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"truncateExpected": "first second of minute"
}
]
}
}
}
request.bodyMatcher.or[].truncateActualOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"truncateActual": "first second of minute"
}
]
}
}
}
request.bodyMatcher.or[].applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"applyTruncationLast": true
}
]
}
}
}
request.bodyMatcher.or[].expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"expectedOffset": 1
}
]
}
}
}
request.bodyMatcher.or[].expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"expectedOffsetUnit": "SECONDS"
}
]
}
}
}
request.bodyMatcher.or[].anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"anything": "anything"
}
]
}
}
}
request.bodyMatcher.or[].absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"absent": true
}
]
}
}
}
request.bodyMatcher.or[].andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
]
}
}
}
request.bodyMatcher.or[].orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
]
}
}
}
request.bodyMatcher.or[].notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"not": {
"contains": "test"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form).
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesPathTemplate": "/orders/{orderId}"
}
]
}
}
}
request.bodyMatcher.or[].matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesXml": "<order><id>42</id></order>"
}
]
}
}
}
request.bodyMatcher.or[].matchesJsonTraffic Parrot: JSON match where values may be regular expressions. Inline JSON value or a string containing JSON.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesJson": {
"orderId": 42
}
}
]
}
}
}
request.bodyMatcher.or[].matchesGraphQLTraffic Parrot: GraphQL query match. A query string or an {"operationName": ..., "variables": ...} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesGraphQL": "{ order(id: 42) { status } }"
}
]
}
}
}
request.bodyMatcher.or[].matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesSwiftField": {
"field": "20"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesFixField": {
"field": "35"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesFixField": {
"matches": "D"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsFieldTraffic 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.
objectExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.fieldPath 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"equalTo": "1234567890"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"greaterThan": 100
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"lessThan": 1000
}
}
]
}
}
}
request.bodyMatcher.or[].matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"or": [
{
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
]
}
}
}
request.bodyMatcher.notThe nested matcher must not match. Nested matchers take inline values only.
matcherequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"contains": "test"
}
}
}
}
request.bodyMatcher.not.equalToExact string equality.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"equalTo": "ORD-42"
}
}
}
}
request.bodyMatcher.not.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"caseInsensitive": true
}
}
}
}
request.bodyMatcher.not.equalToJsonSemantic JSON equality. Inline JSON value or a string containing JSON.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"equalToJson": {
"orderId": 42
}
}
}
}
}
request.bodyMatcher.not.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"ignoreArrayOrder": true
}
}
}
}
request.bodyMatcher.not.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"ignoreExtraElements": true
}
}
}
}
request.bodyMatcher.not.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"treatNullAsAbsent": true
}
}
}
}
request.bodyMatcher.not.matchesJsonSchemaValue must validate against the given JSON Schema (inline object or string).
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
}
request.bodyMatcher.not.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"bodyMatcher": {
"not": {
"schemaVersion": "V202012"
}
}
}
}
request.bodyMatcher.not.equalToXmlSemantic XML equality.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
}
request.bodyMatcher.not.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"enablePlaceholders": true
}
}
}
}
request.bodyMatcher.not.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
}
request.bodyMatcher.not.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
}
request.bodyMatcher.not.exemptedComparisonsOption for equalToXml: XMLUnit ComparisonType names to exempt, in upper case as listed. Checked only beside equalToXml, the matcher that reads it.
[string]Example in context:
{
"request": {
"bodyMatcher": {
"not": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
}
request.bodyMatcher.not.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"ignoreOrderOfSameNode": true
}
}
}
}
request.bodyMatcher.not.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"bodyMatcher": {
"not": {
"namespaceAwareness": "NONE"
}
}
}
}
request.bodyMatcher.not.matchesJsonPathJSONPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesJsonPath": "$.orderId"
}
}
}
}
request.bodyMatcher.not.matchesXPathXPath expression match: a string expression or an advanced {"expression": ..., <sub-matcher>} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesXPath": "/order/id"
}
}
}
}
request.bodyMatcher.not.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"bodyMatcher": {
"not": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
}
request.bodyMatcher.not.containsSubstring match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"contains": "orderId"
}
}
}
}
request.bodyMatcher.not.doesNotContainNegative substring match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"doesNotContain": "error"
}
}
}
}
request.bodyMatcher.not.matchesRegex match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matches": "ORD-[0-9]+"
}
}
}
}
request.bodyMatcher.not.doesNotMatchNegative regex match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"doesNotMatch": ".*test.*"
}
}
}
}
request.bodyMatcher.not.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"before": "now +1 days"
}
}
}
}
request.bodyMatcher.not.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"after": "2026-01-01T00:00:00Z"
}
}
}
}
request.bodyMatcher.not.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"equalToDateTime": "now"
}
}
}
}
request.bodyMatcher.not.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"actualFormat": "dd/MM/yyyy"
}
}
}
}
request.bodyMatcher.not.truncateExpectedOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"truncateExpected": "first second of minute"
}
}
}
}
request.bodyMatcher.not.truncateActualOption 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"truncateActual": "first second of minute"
}
}
}
}
request.bodyMatcher.not.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"applyTruncationLast": true
}
}
}
}
request.bodyMatcher.not.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"expectedOffset": 1
}
}
}
}
request.bodyMatcher.not.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"expectedOffsetUnit": "SECONDS"
}
}
}
}
request.bodyMatcher.not.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"anything": "anything"
}
}
}
}
request.bodyMatcher.not.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"absent": true
}
}
}
}
request.bodyMatcher.not.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"bodyMatcher": {
"not": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
}
request.bodyMatcher.not.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"bodyMatcher": {
"not": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
}
request.bodyMatcher.not.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"not": {
"contains": "test"
}
}
}
}
}
request.bodyMatcher.not.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form).
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
}
request.bodyMatcher.not.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
}
request.bodyMatcher.not.matchesJsonTraffic Parrot: JSON match where values may be regular expressions. Inline JSON value or a string containing JSON.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesJson": {
"orderId": 42
}
}
}
}
}
request.bodyMatcher.not.matchesGraphQLTraffic Parrot: GraphQL query match. A query string or an {"operationName": ..., "variables": ...} object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
}
request.bodyMatcher.not.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
}
request.bodyMatcher.not.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
}
request.bodyMatcher.not.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
}
request.bodyMatcher.not.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
}
request.bodyMatcher.not.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesFixField": {
"field": "35"
}
}
}
}
}
request.bodyMatcher.not.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesFixField": {
"matches": "D"
}
}
}
}
}
request.bodyMatcher.not.matchesCicsFieldTraffic 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.
objectExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.fieldPath 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
}
request.bodyMatcher.not.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"not": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
}
request.bodyMatcher.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form).
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
request.bodyMatcher.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
request.bodyMatcher.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.bodyMatcher.matchesJsonTraffic Parrot: JSON match where values may be regular expressions. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"bodyMatcher": {
"matchesJson": {
"orderId": 42
}
}
}
}
request.bodyMatcher.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
request.bodyMatcher.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
request.bodyMatcher.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
request.bodyMatcher.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
request.bodyMatcher.matchesSwiftField.bodyFileNameName of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
request.bodyMatcher.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"bodyMatcher": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
request.bodyMatcher.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesFixField": {
"field": "35"
}
}
}
}
request.bodyMatcher.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesFixField": {
"matches": "D"
}
}
}
}
request.bodyMatcher.matchesFixField.bodyFileNameName of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
request.bodyMatcher.matchesCicsFieldTraffic 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.
matcherfield, bodyFileNameExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
request.bodyMatcher.matchesCicsField.fieldPath 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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
request.bodyMatcher.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
request.bodyMatcher.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
request.bodyMatcher.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
request.bodyMatcher.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
request.bodyMatcher.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
request.bodyMatcher.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
request.bodyMatcher.matchesCicsField.bodyFileNameName of a file under __files that holds this matcher's value, in place of an inline one. Use it alone.
stringExample in context:
{
"request": {
"bodyMatcher": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
request.bodyMatcher.binaryEqualToByte-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.
stringExample in context:
{
"request": {
"bodyMatcher": {
"binaryEqualTo": "SGVsbG8="
}
}
}
responseDEPRECATED 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.
objectExample in context:
{
"response": {
"destination": {
"name": "ORDERS.RESPONSE",
"type": "QUEUE"
},
"text": "{\"status\": \"accepted\"}",
"format": "MQFMT_STRING"
}
}
response.destinationA messaging destination: queue or topic name.
objectExample in context:
{
"response": {
"destination": {
"name": "ORDERS.RESPONSE",
"type": "QUEUE"
}
}
}
response.destination.nameQueue or topic name.
stringExample in context:
{
"response": {
"destination": {
"name": "ORDERS.REQUEST"
}
}
}
response.destination.typeDestination type.
string"QUEUE", "TOPIC"Example in context:
{
"response": {
"destination": {
"type": "QUEUE"
}
}
}
response.destination.skipDeclareAn 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.
booleanExample in context:
{
"response": {
"destination": {
"skipDeclare": false
}
}
}
response.destination.declareArgumentsAn 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.
objectExample in context:
{
"response": {
"destination": {
"declareArguments": {}
}
}
}
response.textResponse 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.
stringExample in context:
{
"response": {
"text": "{\"status\": \"accepted\"}"
}
}
response.bodyFileNameResponse 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.
stringExample in context:
{
"response": {
"bodyFileName": "responses/order-accepted.json"
}
}
response.formatMQ message format (default MQFMT_STRING). MQFMT_RF_HEADER_1/2 and MQFMT_NONE write the text as printable-characters-decoded bytes.
string"MQFMT_STRING", "MQFMT_RF_HEADER_1", "MQFMT_RF_HEADER_2", "MQFMT_NONE"Example in context:
{
"response": {
"format": "MQFMT_STRING"
}
}
response.characterSetCharacter set (CCSID) used when writing an MQFMT_STRING body (default UTF_8).
string"UTF_8", "UNICODE", "ASCII_850", "ISO_8859_1", "EBCDIC_US"Example in context:
{
"response": {
"characterSet": "UTF_8"
}
}
response.fixedDelayMillisecondsFixed delay in milliseconds before sending this response (default 0). This schema accepts 0 or more.
integerExample in context:
{
"response": {
"fixedDelayMilliseconds": 250
}
}
response.ibmMqResponseTransformerClassNameFully-qualified class name of an SDK response transformer, or the NO_TRANSFORMER sentinel.
stringExample in context:
{
"response": {
"ibmMqResponseTransformerClassName": "com.example.OrderResponseTransformer"
}
}
response.destinationLookupHow 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.
any JSONnull, "USE_REQUEST_MESSAGE_REPLY_TO_QUEUE_NAME_OR_MAPPING_RESPONSE_DESTINATION", "USE_MAPPING_RESPONSE_DESTINATION"Example in context:
{
"response": {
"destinationLookup": "USE_MAPPING_RESPONSE_DESTINATION"
}
}
response.replyToQueueManagerNameReply-to queue manager name set on the response message.
stringExample in context:
{
"response": {
"replyToQueueManagerName": "QM1"
}
}
response.replyToQueueNameReply-to queue name set on the response message.
stringExample in context:
{
"response": {
"replyToQueueName": "ORDERS.REPLY"
}
}
response.never-serialized-fieldLeave this key out: Traffic Parrot never writes it, and null is the only value it accepts.
nullExample in context:
{
"response": {
"never-serialized-field": null
}
}
responsesResponses 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.
[object]Example in context:
{
"responses": [
{
"destination": {
"name": "ORDERS.RESPONSE",
"type": "QUEUE"
},
"text": "{\"status\": \"accepted\"}",
"format": "MQFMT_STRING"
}
]
}
responses[].destinationA messaging destination: queue or topic name.
objectExample in context:
{
"responses": [
{
"destination": {
"name": "ORDERS.RESPONSE",
"type": "QUEUE"
}
}
]
}
responses[].destination.nameQueue or topic name.
stringExample in context:
{
"responses": [
{
"destination": {
"name": "ORDERS.REQUEST"
}
}
]
}
responses[].destination.typeDestination type.
string"QUEUE", "TOPIC"Example in context:
{
"responses": [
{
"destination": {
"type": "QUEUE"
}
}
]
}
responses[].destination.skipDeclareAn 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.
booleanExample in context:
{
"responses": [
{
"destination": {
"skipDeclare": false
}
}
]
}
responses[].destination.declareArgumentsAn 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.
objectExample in context:
{
"responses": [
{
"destination": {
"declareArguments": {}
}
}
]
}
responses[].textResponse 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.
stringExample in context:
{
"responses": [
{
"text": "{\"status\": \"accepted\"}"
}
]
}
responses[].bodyFileNameResponse 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.
stringExample in context:
{
"responses": [
{
"bodyFileName": "responses/order-accepted.json"
}
]
}
responses[].formatMQ message format (default MQFMT_STRING). MQFMT_RF_HEADER_1/2 and MQFMT_NONE write the text as printable-characters-decoded bytes.
string"MQFMT_STRING", "MQFMT_RF_HEADER_1", "MQFMT_RF_HEADER_2", "MQFMT_NONE"Example in context:
{
"responses": [
{
"format": "MQFMT_STRING"
}
]
}
responses[].characterSetCharacter set (CCSID) used when writing an MQFMT_STRING body (default UTF_8).
string"UTF_8", "UNICODE", "ASCII_850", "ISO_8859_1", "EBCDIC_US"Example in context:
{
"responses": [
{
"characterSet": "UTF_8"
}
]
}
responses[].fixedDelayMillisecondsFixed delay in milliseconds before sending this response (default 0). This schema accepts 0 or more.
integerExample in context:
{
"responses": [
{
"fixedDelayMilliseconds": 250
}
]
}
responses[].ibmMqResponseTransformerClassNameFully-qualified class name of an SDK response transformer, or the NO_TRANSFORMER sentinel.
stringExample in context:
{
"responses": [
{
"ibmMqResponseTransformerClassName": "com.example.OrderResponseTransformer"
}
]
}
responses[].destinationLookupHow 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.
any JSONnull, "USE_REQUEST_MESSAGE_REPLY_TO_QUEUE_NAME_OR_MAPPING_RESPONSE_DESTINATION", "USE_MAPPING_RESPONSE_DESTINATION"Example in context:
{
"responses": [
{
"destinationLookup": "USE_MAPPING_RESPONSE_DESTINATION"
}
]
}
responses[].replyToQueueManagerNameReply-to queue manager name set on the response message.
stringExample in context:
{
"responses": [
{
"replyToQueueManagerName": "QM1"
}
]
}
responses[].replyToQueueNameReply-to queue name set on the response message.
stringExample in context:
{
"responses": [
{
"replyToQueueName": "ORDERS.REPLY"
}
]
}
responses[].never-serialized-fieldLeave this key out: Traffic Parrot never writes it, and null is the only value it accepts.
nullExample in context:
{
"responses": [
{
"never-serialized-field": null
}
]
}
receiveThreadsNumber of threads receiving from the request destination (default 1). This schema accepts 1 or more.
integerExample in context:
{
"receiveThreads": 1
}
sendThreadsNumber of threads sending responses (default 1). This schema accepts 1 or more.
integerExample in context:
{
"sendThreads": 1
}
maxMessagesInProgressMaximum number of messages processed concurrently. Unlimited when absent. This schema accepts 1 or more.
integerExample in context:
{
"maxMessagesInProgress": 100
}