Every key in gRPC mapping files, from the schema grpc-mapping.schema.json. The mapping explorer shows the same keys as a tree and checks a mapping against them.
One Traffic Parrot gRPC mapping, written like an HTTP mapping, as a JSON file in the grpc-mappings directory (grpc-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/http-mapping.schema.json"
}
idUnique identifier for the mapping. Traffic Parrot-written files carry both id and uuid with the same value.
stringExample in context:
{
"id": "0b1d4c39-6c2f-4e0e-9a51-8f2a3c5d7e90"
}
uuidAlternative property name for the unique identifier.
stringExample in context:
{
"uuid": "0b1d4c39-6c2f-4e0e-9a51-8f2a3c5d7e90"
}
nameHuman-readable name for the mapping.
stringExample in context:
{
"name": "get-open-orders"
}
persistentWhether this mapping should be persisted to disk.
booleanExample in context:
{
"persistent": true
}
priorityPriority of this mapping (default 5, lower number = higher priority).
integerExample in context:
{
"priority": 1
}
scenarioNameName of the state-machine scenario this mapping belongs to (not a Traffic Parrot scenario directory).
stringExample in context:
{
"scenarioName": "order-lifecycle"
}
requiredScenarioStateRequired scenario state for this mapping to match.
stringExample in context:
{
"requiredScenarioState": "Started"
}
newScenarioStateNew scenario state to set after this mapping is matched.
stringExample in context:
{
"newScenarioState": "order-placed"
}
insertionIndexInternal ordering index. Accepted on input but not normally present in mapping files.
integerExample in context:
{
"insertionIndex": 0
}
postServeActionsActions to perform after the response is served. Array form [{name, parameters}] or legacy object form {"<name>": {parameters}}.
array | objectExample in context:
{
"postServeActions": [
{
"name": "webhook",
"parameters": {
"method": "POST",
"url": "http://localhost:9090/callback"
}
}
]
}
serveEventListenersServe event listeners to notify.
[object]Example in context:
{
"serveEventListeners": [
{
"name": "webhook",
"requestPhases": [
"AFTER_COMPLETE"
],
"parameters": {
"method": "POST",
"url": "http://localhost:9090/callback"
}
}
]
}
serveEventListeners[].nameName of the serve event listener extension to notify, for example webhook.
stringExample in context:
{
"serveEventListeners": [
{
"name": "webhook"
}
]
}
serveEventListeners[].requestPhasesRequest phases at which the listener is called.
[string]Example in context:
{
"serveEventListeners": [
{
"requestPhases": [
"AFTER_COMPLETE"
]
}
]
}
serveEventListeners[].parametersParameters passed to the listener. Their keys depend on the listener.
objectExample in context:
{
"serveEventListeners": [
{
"parameters": {
"method": "POST",
"url": "http://localhost:9090/callback"
}
}
]
}
metadataCustom metadata associated with this mapping. Any key is accepted here.
objectExample in context:
{
"metadata": {
"team": "payments",
"ticket": "PAY-123"
}
}
requestRequest matching criteria. Use at most one of url / urlPattern / urlPath / urlPathPattern / urlPathTemplate. A misspelt key here is ignored when the mapping loads, which leaves a mapping that matches more requests than intended; a check against this schema rejects it.
objectExample in context:
{
"request": {
"urlPath": "com.example.Shipping/CreateShippingDetails",
"method": "ANY",
"headers": {
"Protocol": {
"equalTo": "GRPC"
}
},
"bodyPatterns": [
{
"matchesJsonPath": "$[?(@.last_name == 'Smith')]"
}
]
}
}
request.urlExact URL including query string.
stringExample in context:
{
"request": {
"url": "/orders?status=open"
}
}
request.urlPatternRegex on the full URL including query string.
stringExample in context:
{
"request": {
"urlPattern": "/orders/[0-9]+.*"
}
}
request.urlPathThe gRPC method, as package.Service/Method with no leading slash. Replay matches a call on this path, so a leading slash or any other form never answers. Traffic Parrot writes urlPath, and reads it to name mapping files and to check mappings against the proto files.
stringExample in context:
{
"request": {
"urlPath": "com.example.Shipping/CreateShippingDetails"
}
}
request.urlPathPatternRegex on the URL path (query string ignored).
stringExample in context:
{
"request": {
"urlPathPattern": "/orders/[0-9]+"
}
}
request.urlPathTemplateRFC 6570 path template, e.g. /users/{id}. Enables pathParameters matching.
stringExample in context:
{
"request": {
"urlPathTemplate": "/orders/{orderId}"
}
}
request.methodANY, or leave it out. Replay matches every gRPC call as method ANY, so any other method never answers.
string"ANY"Example in context:
{
"request": {
"method": "ANY"
}
}
request.schemeURL scheme to match.
string"http", "https"Example in context:
{
"request": {
"scheme": "https"
}
}
request.hostMatcher on the request host.
matcherequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"host": {
"equalTo": "api.example.com"
}
}
}
request.host.equalToExact string equality.
string | objectExample in context:
{
"request": {
"host": {
"equalTo": "application/json"
}
}
}
request.host.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"host": {
"caseInsensitive": true
}
}
}
request.host.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"host": {
"equalToJson": {
"orderId": 42
}
}
}
}
request.host.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"host": {
"ignoreArrayOrder": true
}
}
}
request.host.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"host": {
"ignoreExtraElements": true
}
}
}
request.host.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"host": {
"treatNullAsAbsent": true
}
}
}
request.host.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"host": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
request.host.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"host": {
"schemaVersion": "V202012"
}
}
}
request.host.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"host": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
request.host.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"host": {
"enablePlaceholders": true
}
}
}
request.host.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"host": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
request.host.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"host": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
request.host.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": {
"host": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
request.host.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"host": {
"ignoreOrderOfSameNode": true
}
}
}
request.host.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"host": {
"namespaceAwareness": "NONE"
}
}
}
request.host.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"host": {
"matchesJsonPath": "$.orderId"
}
}
}
request.host.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"host": {
"matchesXPath": "/order/id"
}
}
}
request.host.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"host": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
request.host.containsSubstring match.
string | objectExample in context:
{
"request": {
"host": {
"contains": "orderId"
}
}
}
request.host.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"host": {
"doesNotContain": "error"
}
}
}
request.host.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.matchesRegex match.
string | objectExample in context:
{
"request": {
"host": {
"matches": "ORD-[0-9]+"
}
}
}
request.host.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"host": {
"doesNotMatch": ".*test.*"
}
}
}
request.host.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"host": {
"before": "now +1 days"
}
}
}
request.host.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"host": {
"after": "2026-01-01T00:00:00Z"
}
}
}
request.host.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"host": {
"equalToDateTime": "now"
}
}
}
request.host.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"host": {
"actualFormat": "dd/MM/yyyy"
}
}
}
request.host.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": {
"host": {
"truncateExpected": "first second of minute"
}
}
}
request.host.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": {
"host": {
"truncateActual": "first second of minute"
}
}
}
request.host.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"host": {
"applyTruncationLast": true
}
}
}
request.host.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"host": {
"expectedOffset": 1
}
}
}
request.host.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"host": {
"expectedOffsetUnit": "SECONDS"
}
}
}
request.host.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"host": {
"anything": "anything"
}
}
}
request.host.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"host": {
"absent": true
}
}
}
request.host.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"host": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
request.host.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"host": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
request.host.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"host": {
"not": {
"contains": "test"
}
}
}
}
request.host.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"host": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
request.host.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"host": {
"binaryEqualTo": "SGVsbG8="
}
}
}
request.host.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"host": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
request.host.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"host": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.host.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": {
"host": {
"matchesJson": {
"orderId": 42
}
}
}
}
request.host.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"host": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
request.host.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"host": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
request.host.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"host": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
request.host.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"host": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
request.host.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": {
"host": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
request.host.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"host": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
request.host.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"host": {
"matchesFixField": {
"field": "35"
}
}
}
}
request.host.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"host": {
"matchesFixField": {
"matches": "D"
}
}
}
}
request.host.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": {
"host": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
request.host.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
request.host.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": {
"host": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
request.host.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
request.host.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
request.host.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
request.host.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
request.host.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
request.host.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"host": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
request.host.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": {
"host": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
request.portPort number to match.
integerExample in context:
{
"request": {
"port": 8443
}
}
request.clientIpMatcher on the client IP address.
matcherequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"clientIp": {
"matches": "10\\.0\\..*"
}
}
}
request.clientIp.equalToExact string equality.
string | objectExample in context:
{
"request": {
"clientIp": {
"equalTo": "application/json"
}
}
}
request.clientIp.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"clientIp": {
"caseInsensitive": true
}
}
}
request.clientIp.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"clientIp": {
"equalToJson": {
"orderId": 42
}
}
}
}
request.clientIp.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"clientIp": {
"ignoreArrayOrder": true
}
}
}
request.clientIp.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"clientIp": {
"ignoreExtraElements": true
}
}
}
request.clientIp.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"clientIp": {
"treatNullAsAbsent": true
}
}
}
request.clientIp.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"clientIp": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
request.clientIp.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"clientIp": {
"schemaVersion": "V202012"
}
}
}
request.clientIp.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"clientIp": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
request.clientIp.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"clientIp": {
"enablePlaceholders": true
}
}
}
request.clientIp.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"clientIp": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
request.clientIp.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"clientIp": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
request.clientIp.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": {
"clientIp": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
request.clientIp.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"clientIp": {
"ignoreOrderOfSameNode": true
}
}
}
request.clientIp.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"clientIp": {
"namespaceAwareness": "NONE"
}
}
}
request.clientIp.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"clientIp": {
"matchesJsonPath": "$.orderId"
}
}
}
request.clientIp.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"clientIp": {
"matchesXPath": "/order/id"
}
}
}
request.clientIp.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"clientIp": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
request.clientIp.containsSubstring match.
string | objectExample in context:
{
"request": {
"clientIp": {
"contains": "orderId"
}
}
}
request.clientIp.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"clientIp": {
"doesNotContain": "error"
}
}
}
request.clientIp.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.matchesRegex match.
string | objectExample in context:
{
"request": {
"clientIp": {
"matches": "ORD-[0-9]+"
}
}
}
request.clientIp.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"clientIp": {
"doesNotMatch": ".*test.*"
}
}
}
request.clientIp.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"clientIp": {
"before": "now +1 days"
}
}
}
request.clientIp.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"clientIp": {
"after": "2026-01-01T00:00:00Z"
}
}
}
request.clientIp.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"clientIp": {
"equalToDateTime": "now"
}
}
}
request.clientIp.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"clientIp": {
"actualFormat": "dd/MM/yyyy"
}
}
}
request.clientIp.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": {
"clientIp": {
"truncateExpected": "first second of minute"
}
}
}
request.clientIp.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": {
"clientIp": {
"truncateActual": "first second of minute"
}
}
}
request.clientIp.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"clientIp": {
"applyTruncationLast": true
}
}
}
request.clientIp.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"clientIp": {
"expectedOffset": 1
}
}
}
request.clientIp.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"clientIp": {
"expectedOffsetUnit": "SECONDS"
}
}
}
request.clientIp.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"clientIp": {
"anything": "anything"
}
}
}
request.clientIp.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"clientIp": {
"absent": true
}
}
}
request.clientIp.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"clientIp": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
request.clientIp.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"clientIp": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
request.clientIp.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"clientIp": {
"not": {
"contains": "test"
}
}
}
}
request.clientIp.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"clientIp": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
request.clientIp.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"clientIp": {
"binaryEqualTo": "SGVsbG8="
}
}
}
request.clientIp.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"clientIp": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
request.clientIp.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"clientIp": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
request.clientIp.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": {
"clientIp": {
"matchesJson": {
"orderId": 42
}
}
}
}
request.clientIp.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"clientIp": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
request.clientIp.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"clientIp": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
request.clientIp.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"clientIp": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
request.clientIp.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"clientIp": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
request.clientIp.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": {
"clientIp": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
request.clientIp.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"clientIp": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
request.clientIp.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"clientIp": {
"matchesFixField": {
"field": "35"
}
}
}
}
request.clientIp.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"clientIp": {
"matchesFixField": {
"matches": "D"
}
}
}
}
request.clientIp.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": {
"clientIp": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
request.clientIp.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
request.clientIp.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": {
"clientIp": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
request.clientIp.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
request.clientIp.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
request.clientIp.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
request.clientIp.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
request.clientIp.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
request.clientIp.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"clientIp": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
request.clientIp.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": {
"clientIp": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
request.headersThe call's metadata to match: name to matcher (or hasExactly / includes multi-value form). Traffic Parrot also writes the matcher "Protocol": {"equalTo": "GRPC"}: every replayed call carries that header, so it may be left out, and a matcher for any other value never answers.
{name: matcher}equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesExample in context:
{
"request": {
"headers": {
"Accept": {
"contains": "json"
}
}
}
}
request.headers.*Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.
objectequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesrequest.headers.*.equalToExact string equality.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"equalTo": "application/json"
}
}
}
}
request.headers.*.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"caseInsensitive": true
}
}
}
}
request.headers.*.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"headers": {
"name": {
"equalToJson": {
"orderId": 42
}
}
}
}
}
request.headers.*.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"ignoreArrayOrder": true
}
}
}
}
request.headers.*.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"ignoreExtraElements": true
}
}
}
}
request.headers.*.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"treatNullAsAbsent": true
}
}
}
}
request.headers.*.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
}
request.headers.*.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"headers": {
"name": {
"schemaVersion": "V202012"
}
}
}
}
request.headers.*.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
}
request.headers.*.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"enablePlaceholders": true
}
}
}
}
request.headers.*.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"headers": {
"name": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
}
request.headers.*.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"headers": {
"name": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
}
request.headers.*.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"ignoreOrderOfSameNode": true
}
}
}
}
request.headers.*.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"headers": {
"name": {
"namespaceAwareness": "NONE"
}
}
}
}
request.headers.*.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesJsonPath": "$.orderId"
}
}
}
}
request.headers.*.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesXPath": "/order/id"
}
}
}
}
request.headers.*.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"headers": {
"name": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
}
request.headers.*.containsSubstring match.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"contains": "orderId"
}
}
}
}
request.headers.*.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"doesNotContain": "error"
}
}
}
}
request.headers.*.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.matchesRegex match.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"matches": "ORD-[0-9]+"
}
}
}
}
request.headers.*.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"doesNotMatch": ".*test.*"
}
}
}
}
request.headers.*.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"headers": {
"name": {
"before": "now +1 days"
}
}
}
}
request.headers.*.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"headers": {
"name": {
"after": "2026-01-01T00:00:00Z"
}
}
}
}
request.headers.*.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"headers": {
"name": {
"equalToDateTime": "now"
}
}
}
}
request.headers.*.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"actualFormat": "dd/MM/yyyy"
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"truncateExpected": "first second of minute"
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"truncateActual": "first second of minute"
}
}
}
}
request.headers.*.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"headers": {
"name": {
"applyTruncationLast": true
}
}
}
}
request.headers.*.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"headers": {
"name": {
"expectedOffset": 1
}
}
}
}
request.headers.*.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"headers": {
"name": {
"expectedOffsetUnit": "SECONDS"
}
}
}
}
request.headers.*.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"headers": {
"name": {
"anything": "anything"
}
}
}
}
request.headers.*.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"headers": {
"name": {
"absent": true
}
}
}
}
request.headers.*.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"headers": {
"name": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
}
request.headers.*.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"headers": {
"name": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
}
request.headers.*.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"headers": {
"name": {
"not": {
"contains": "test"
}
}
}
}
}
request.headers.*.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
}
request.headers.*.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"binaryEqualTo": "SGVsbG8="
}
}
}
}
request.headers.*.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
}
request.headers.*.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"matchesJson": {
"orderId": 42
}
}
}
}
}
request.headers.*.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
}
request.headers.*.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
}
request.headers.*.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
}
request.headers.*.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
}
request.headers.*.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
}
request.headers.*.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesFixField": {
"field": "35"
}
}
}
}
}
request.headers.*.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesFixField": {
"matches": "D"
}
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
}
request.headers.*.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
}
request.headers.*.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
}
request.headers.*.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
}
request.headers.*.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
}
request.headers.*.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
}
request.headers.*.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
}
request.headers.*.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"headers": {
"name": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
}
request.headers.*.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": {
"headers": {
"name": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
}
request.headers.*.hasExactlyThe header or parameter has exactly these values, one matching each matcher, in any order.
[matcher]Example in context:
{
"request": {
"headers": {
"name": {
"hasExactly": [
{
"equalTo": "red"
},
{
"equalTo": "blue"
}
]
}
}
}
}
request.headers.*.includesThe header or parameter has, among its values, one matching each matcher.
[matcher]Example in context:
{
"request": {
"headers": {
"name": {
"includes": [
{
"equalTo": "red"
}
]
}
}
}
}
request.queryParametersQuery parameters to match.
{name: matcher}equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesExample in context:
{
"request": {
"queryParameters": {
"status": {
"equalTo": "open"
}
}
}
}
request.queryParameters.*Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.
objectequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesrequest.queryParameters.*.equalToExact string equality.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"equalTo": "application/json"
}
}
}
}
request.queryParameters.*.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"caseInsensitive": true
}
}
}
}
request.queryParameters.*.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"queryParameters": {
"name": {
"equalToJson": {
"orderId": 42
}
}
}
}
}
request.queryParameters.*.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"ignoreArrayOrder": true
}
}
}
}
request.queryParameters.*.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"ignoreExtraElements": true
}
}
}
}
request.queryParameters.*.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"treatNullAsAbsent": true
}
}
}
}
request.queryParameters.*.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
}
request.queryParameters.*.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"queryParameters": {
"name": {
"schemaVersion": "V202012"
}
}
}
}
request.queryParameters.*.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
}
request.queryParameters.*.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"enablePlaceholders": true
}
}
}
}
request.queryParameters.*.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
}
request.queryParameters.*.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
}
request.queryParameters.*.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"ignoreOrderOfSameNode": true
}
}
}
}
request.queryParameters.*.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"queryParameters": {
"name": {
"namespaceAwareness": "NONE"
}
}
}
}
request.queryParameters.*.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesJsonPath": "$.orderId"
}
}
}
}
request.queryParameters.*.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesXPath": "/order/id"
}
}
}
}
request.queryParameters.*.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"queryParameters": {
"name": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
}
request.queryParameters.*.containsSubstring match.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"contains": "orderId"
}
}
}
}
request.queryParameters.*.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"doesNotContain": "error"
}
}
}
}
request.queryParameters.*.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.matchesRegex match.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matches": "ORD-[0-9]+"
}
}
}
}
request.queryParameters.*.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"doesNotMatch": ".*test.*"
}
}
}
}
request.queryParameters.*.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"before": "now +1 days"
}
}
}
}
request.queryParameters.*.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"after": "2026-01-01T00:00:00Z"
}
}
}
}
request.queryParameters.*.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"equalToDateTime": "now"
}
}
}
}
request.queryParameters.*.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"actualFormat": "dd/MM/yyyy"
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"truncateExpected": "first second of minute"
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"truncateActual": "first second of minute"
}
}
}
}
request.queryParameters.*.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"queryParameters": {
"name": {
"applyTruncationLast": true
}
}
}
}
request.queryParameters.*.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"queryParameters": {
"name": {
"expectedOffset": 1
}
}
}
}
request.queryParameters.*.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"expectedOffsetUnit": "SECONDS"
}
}
}
}
request.queryParameters.*.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"anything": "anything"
}
}
}
}
request.queryParameters.*.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"queryParameters": {
"name": {
"absent": true
}
}
}
}
request.queryParameters.*.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"queryParameters": {
"name": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
}
request.queryParameters.*.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"queryParameters": {
"name": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
}
request.queryParameters.*.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"queryParameters": {
"name": {
"not": {
"contains": "test"
}
}
}
}
}
request.queryParameters.*.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
}
request.queryParameters.*.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"binaryEqualTo": "SGVsbG8="
}
}
}
}
request.queryParameters.*.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
}
request.queryParameters.*.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"matchesJson": {
"orderId": 42
}
}
}
}
}
request.queryParameters.*.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
}
request.queryParameters.*.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
}
request.queryParameters.*.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
}
request.queryParameters.*.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
}
request.queryParameters.*.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
}
request.queryParameters.*.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesFixField": {
"field": "35"
}
}
}
}
}
request.queryParameters.*.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesFixField": {
"matches": "D"
}
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
}
request.queryParameters.*.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
}
request.queryParameters.*.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
}
request.queryParameters.*.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
}
request.queryParameters.*.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
}
request.queryParameters.*.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
}
request.queryParameters.*.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
}
request.queryParameters.*.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"queryParameters": {
"name": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
}
request.queryParameters.*.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": {
"queryParameters": {
"name": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
}
request.queryParameters.*.hasExactlyThe header or parameter has exactly these values, one matching each matcher, in any order.
[matcher]Example in context:
{
"request": {
"queryParameters": {
"name": {
"hasExactly": [
{
"equalTo": "red"
},
{
"equalTo": "blue"
}
]
}
}
}
}
request.queryParameters.*.includesThe header or parameter has, among its values, one matching each matcher.
[matcher]Example in context:
{
"request": {
"queryParameters": {
"name": {
"includes": [
{
"equalTo": "red"
}
]
}
}
}
}
request.formParametersForm (application/x-www-form-urlencoded) parameters to match.
{name: matcher}equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesExample in context:
{
"request": {
"formParameters": {
"grant_type": {
"equalTo": "client_credentials"
}
}
}
}
request.formParameters.*Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.
objectequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesrequest.formParameters.*.equalToExact string equality.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"equalTo": "application/json"
}
}
}
}
request.formParameters.*.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"caseInsensitive": true
}
}
}
}
request.formParameters.*.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"formParameters": {
"name": {
"equalToJson": {
"orderId": 42
}
}
}
}
}
request.formParameters.*.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"ignoreArrayOrder": true
}
}
}
}
request.formParameters.*.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"ignoreExtraElements": true
}
}
}
}
request.formParameters.*.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"treatNullAsAbsent": true
}
}
}
}
request.formParameters.*.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
}
request.formParameters.*.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"formParameters": {
"name": {
"schemaVersion": "V202012"
}
}
}
}
request.formParameters.*.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
}
request.formParameters.*.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"enablePlaceholders": true
}
}
}
}
request.formParameters.*.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
}
request.formParameters.*.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
}
request.formParameters.*.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"ignoreOrderOfSameNode": true
}
}
}
}
request.formParameters.*.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"formParameters": {
"name": {
"namespaceAwareness": "NONE"
}
}
}
}
request.formParameters.*.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesJsonPath": "$.orderId"
}
}
}
}
request.formParameters.*.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesXPath": "/order/id"
}
}
}
}
request.formParameters.*.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"formParameters": {
"name": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
}
request.formParameters.*.containsSubstring match.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"contains": "orderId"
}
}
}
}
request.formParameters.*.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"doesNotContain": "error"
}
}
}
}
request.formParameters.*.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.matchesRegex match.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matches": "ORD-[0-9]+"
}
}
}
}
request.formParameters.*.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"doesNotMatch": ".*test.*"
}
}
}
}
request.formParameters.*.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"before": "now +1 days"
}
}
}
}
request.formParameters.*.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"after": "2026-01-01T00:00:00Z"
}
}
}
}
request.formParameters.*.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"equalToDateTime": "now"
}
}
}
}
request.formParameters.*.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"actualFormat": "dd/MM/yyyy"
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"truncateExpected": "first second of minute"
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"truncateActual": "first second of minute"
}
}
}
}
request.formParameters.*.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"formParameters": {
"name": {
"applyTruncationLast": true
}
}
}
}
request.formParameters.*.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"formParameters": {
"name": {
"expectedOffset": 1
}
}
}
}
request.formParameters.*.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"expectedOffsetUnit": "SECONDS"
}
}
}
}
request.formParameters.*.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"anything": "anything"
}
}
}
}
request.formParameters.*.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"formParameters": {
"name": {
"absent": true
}
}
}
}
request.formParameters.*.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"formParameters": {
"name": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
}
request.formParameters.*.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"formParameters": {
"name": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
}
request.formParameters.*.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"formParameters": {
"name": {
"not": {
"contains": "test"
}
}
}
}
}
request.formParameters.*.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
}
request.formParameters.*.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"binaryEqualTo": "SGVsbG8="
}
}
}
}
request.formParameters.*.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
}
request.formParameters.*.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"matchesJson": {
"orderId": 42
}
}
}
}
}
request.formParameters.*.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
}
request.formParameters.*.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
}
request.formParameters.*.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
}
request.formParameters.*.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
}
request.formParameters.*.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
}
request.formParameters.*.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesFixField": {
"field": "35"
}
}
}
}
}
request.formParameters.*.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesFixField": {
"matches": "D"
}
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
}
request.formParameters.*.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
}
request.formParameters.*.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
}
request.formParameters.*.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
}
request.formParameters.*.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
}
request.formParameters.*.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
}
request.formParameters.*.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
}
request.formParameters.*.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"formParameters": {
"name": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
}
request.formParameters.*.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": {
"formParameters": {
"name": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
}
request.formParameters.*.hasExactlyThe header or parameter has exactly these values, one matching each matcher, in any order.
[matcher]Example in context:
{
"request": {
"formParameters": {
"name": {
"hasExactly": [
{
"equalTo": "red"
},
{
"equalTo": "blue"
}
]
}
}
}
}
request.formParameters.*.includesThe header or parameter has, among its values, one matching each matcher.
[matcher]Example in context:
{
"request": {
"formParameters": {
"name": {
"includes": [
{
"equalTo": "red"
}
]
}
}
}
}
request.pathParametersPath parameters to match. Only meaningful together with urlPathTemplate.
{name: matcher}equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"pathParameters": {
"orderId": {
"matches": "[0-9]+"
}
}
}
}
request.pathParameters.*A single value matcher in a position where Traffic Parrot will NOT resolve an externalised value. Identical to stringValueMatcher except that the {"bodyFileName": "<file>"} form is refused. Used for host, clientIp, header, query, form, path, cookie and multipart matchers, and for any matcher nested inside and / or / not: Traffic Parrot rejects a bodyFileName reference in all of them.
matcherequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldrequest.pathParameters.*.equalToExact string equality.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"equalTo": "application/json"
}
}
}
}
request.pathParameters.*.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"caseInsensitive": true
}
}
}
}
request.pathParameters.*.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"pathParameters": {
"name": {
"equalToJson": {
"orderId": 42
}
}
}
}
}
request.pathParameters.*.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"ignoreArrayOrder": true
}
}
}
}
request.pathParameters.*.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"ignoreExtraElements": true
}
}
}
}
request.pathParameters.*.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"treatNullAsAbsent": true
}
}
}
}
request.pathParameters.*.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
}
request.pathParameters.*.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"pathParameters": {
"name": {
"schemaVersion": "V202012"
}
}
}
}
request.pathParameters.*.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
}
request.pathParameters.*.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"enablePlaceholders": true
}
}
}
}
request.pathParameters.*.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
}
request.pathParameters.*.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
}
request.pathParameters.*.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"ignoreOrderOfSameNode": true
}
}
}
}
request.pathParameters.*.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"pathParameters": {
"name": {
"namespaceAwareness": "NONE"
}
}
}
}
request.pathParameters.*.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesJsonPath": "$.orderId"
}
}
}
}
request.pathParameters.*.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesXPath": "/order/id"
}
}
}
}
request.pathParameters.*.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"pathParameters": {
"name": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
}
request.pathParameters.*.containsSubstring match.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"contains": "orderId"
}
}
}
}
request.pathParameters.*.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"doesNotContain": "error"
}
}
}
}
request.pathParameters.*.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.matchesRegex match.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matches": "ORD-[0-9]+"
}
}
}
}
request.pathParameters.*.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"doesNotMatch": ".*test.*"
}
}
}
}
request.pathParameters.*.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"before": "now +1 days"
}
}
}
}
request.pathParameters.*.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"after": "2026-01-01T00:00:00Z"
}
}
}
}
request.pathParameters.*.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"equalToDateTime": "now"
}
}
}
}
request.pathParameters.*.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"actualFormat": "dd/MM/yyyy"
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"truncateExpected": "first second of minute"
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"truncateActual": "first second of minute"
}
}
}
}
request.pathParameters.*.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"pathParameters": {
"name": {
"applyTruncationLast": true
}
}
}
}
request.pathParameters.*.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"pathParameters": {
"name": {
"expectedOffset": 1
}
}
}
}
request.pathParameters.*.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"expectedOffsetUnit": "SECONDS"
}
}
}
}
request.pathParameters.*.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"anything": "anything"
}
}
}
}
request.pathParameters.*.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"pathParameters": {
"name": {
"absent": true
}
}
}
}
request.pathParameters.*.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"pathParameters": {
"name": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
}
request.pathParameters.*.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"pathParameters": {
"name": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
}
request.pathParameters.*.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"pathParameters": {
"name": {
"not": {
"contains": "test"
}
}
}
}
}
request.pathParameters.*.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
}
request.pathParameters.*.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"binaryEqualTo": "SGVsbG8="
}
}
}
}
request.pathParameters.*.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
}
request.pathParameters.*.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"matchesJson": {
"orderId": 42
}
}
}
}
}
request.pathParameters.*.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
}
request.pathParameters.*.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
}
request.pathParameters.*.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
}
request.pathParameters.*.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
}
request.pathParameters.*.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
}
request.pathParameters.*.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesFixField": {
"field": "35"
}
}
}
}
}
request.pathParameters.*.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesFixField": {
"matches": "D"
}
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
}
request.pathParameters.*.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
}
request.pathParameters.*.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
}
request.pathParameters.*.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
}
request.pathParameters.*.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
}
request.pathParameters.*.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
}
request.pathParameters.*.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
}
request.pathParameters.*.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"pathParameters": {
"name": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
}
request.pathParameters.*.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": {
"pathParameters": {
"name": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
}
request.cookiesCookies to match.
{name: matcher}equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"cookies": {
"session": {
"matches": ".+"
}
}
}
}
request.cookies.*A single value matcher in a position where Traffic Parrot will NOT resolve an externalised value. Identical to stringValueMatcher except that the {"bodyFileName": "<file>"} form is refused. Used for host, clientIp, header, query, form, path, cookie and multipart matchers, and for any matcher nested inside and / or / not: Traffic Parrot rejects a bodyFileName reference in all of them.
matcherequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldrequest.cookies.*.equalToExact string equality.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"equalTo": "application/json"
}
}
}
}
request.cookies.*.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"caseInsensitive": true
}
}
}
}
request.cookies.*.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"cookies": {
"name": {
"equalToJson": {
"orderId": 42
}
}
}
}
}
request.cookies.*.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"ignoreArrayOrder": true
}
}
}
}
request.cookies.*.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"ignoreExtraElements": true
}
}
}
}
request.cookies.*.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"treatNullAsAbsent": true
}
}
}
}
request.cookies.*.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
}
request.cookies.*.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"cookies": {
"name": {
"schemaVersion": "V202012"
}
}
}
}
request.cookies.*.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
}
request.cookies.*.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"enablePlaceholders": true
}
}
}
}
request.cookies.*.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
}
request.cookies.*.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
}
request.cookies.*.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"ignoreOrderOfSameNode": true
}
}
}
}
request.cookies.*.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"cookies": {
"name": {
"namespaceAwareness": "NONE"
}
}
}
}
request.cookies.*.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesJsonPath": "$.orderId"
}
}
}
}
request.cookies.*.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesXPath": "/order/id"
}
}
}
}
request.cookies.*.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"cookies": {
"name": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
}
request.cookies.*.containsSubstring match.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"contains": "orderId"
}
}
}
}
request.cookies.*.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"doesNotContain": "error"
}
}
}
}
request.cookies.*.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.matchesRegex match.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"matches": "ORD-[0-9]+"
}
}
}
}
request.cookies.*.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"doesNotMatch": ".*test.*"
}
}
}
}
request.cookies.*.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"before": "now +1 days"
}
}
}
}
request.cookies.*.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"after": "2026-01-01T00:00:00Z"
}
}
}
}
request.cookies.*.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"equalToDateTime": "now"
}
}
}
}
request.cookies.*.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"actualFormat": "dd/MM/yyyy"
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"truncateExpected": "first second of minute"
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"truncateActual": "first second of minute"
}
}
}
}
request.cookies.*.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"cookies": {
"name": {
"applyTruncationLast": true
}
}
}
}
request.cookies.*.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"cookies": {
"name": {
"expectedOffset": 1
}
}
}
}
request.cookies.*.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"expectedOffsetUnit": "SECONDS"
}
}
}
}
request.cookies.*.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"anything": "anything"
}
}
}
}
request.cookies.*.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"cookies": {
"name": {
"absent": true
}
}
}
}
request.cookies.*.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"cookies": {
"name": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
}
request.cookies.*.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"cookies": {
"name": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
}
request.cookies.*.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"cookies": {
"name": {
"not": {
"contains": "test"
}
}
}
}
}
request.cookies.*.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
}
request.cookies.*.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"binaryEqualTo": "SGVsbG8="
}
}
}
}
request.cookies.*.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
}
request.cookies.*.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"matchesJson": {
"orderId": 42
}
}
}
}
}
request.cookies.*.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
}
request.cookies.*.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
}
request.cookies.*.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
}
request.cookies.*.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
}
request.cookies.*.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
}
request.cookies.*.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesFixField": {
"field": "35"
}
}
}
}
}
request.cookies.*.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesFixField": {
"matches": "D"
}
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
}
request.cookies.*.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
}
request.cookies.*.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
}
request.cookies.*.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
}
request.cookies.*.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
}
request.cookies.*.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
}
request.cookies.*.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
}
request.cookies.*.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"cookies": {
"name": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
}
request.cookies.*.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": {
"cookies": {
"name": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
}
request.basicAuthBasic authentication credentials to match.
objectExample in context:
{
"request": {
"basicAuth": {
"username": "api-user",
"password": "secret"
}
}
}
request.basicAuth.usernameUser name the request's Basic Authorization header must carry.
stringExample in context:
{
"request": {
"basicAuth": {
"username": "api-user"
}
}
}
request.basicAuth.passwordPassword the request's Basic Authorization header must carry.
stringExample in context:
{
"request": {
"basicAuth": {
"password": "secret"
}
}
}
request.bodyPatternsMatching patterns for the request message, which is matched as JSON. All patterns must match.
[matcher]equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesJsonPath": "$.items[?(@.quantity > 0)]"
}
]
}
}
request.bodyPatterns[].equalToExact string equality.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"equalTo": "application/json"
}
]
}
}
request.bodyPatterns[].equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"caseInsensitive": true
}
]
}
}
request.bodyPatterns[].equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"bodyPatterns": [
{
"equalToJson": {
"orderId": 42
}
}
]
}
}
request.bodyPatterns[].ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"ignoreArrayOrder": true
}
]
}
}
request.bodyPatterns[].ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"ignoreExtraElements": true
}
]
}
}
request.bodyPatterns[].treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"treatNullAsAbsent": true
}
]
}
}
request.bodyPatterns[].matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
]
}
}
request.bodyPatterns[].schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"bodyPatterns": [
{
"schemaVersion": "V202012"
}
]
}
}
request.bodyPatterns[].equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"equalToXml": "<order><id>42</id></order>"
}
]
}
}
request.bodyPatterns[].equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"enablePlaceholders": true
}
]
}
}
request.bodyPatterns[].placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"placeholderOpeningDelimiterRegex": "\\[\\["
}
]
}
}
request.bodyPatterns[].placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"placeholderClosingDelimiterRegex": "\\]\\]"
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
]
}
}
request.bodyPatterns[].ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"ignoreOrderOfSameNode": true
}
]
}
}
request.bodyPatterns[].namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"bodyPatterns": [
{
"namespaceAwareness": "NONE"
}
]
}
}
request.bodyPatterns[].matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesJsonPath": "$.orderId"
}
]
}
}
request.bodyPatterns[].matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesXPath": "/order/id"
}
]
}
}
request.bodyPatterns[].xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"bodyPatterns": [
{
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
]
}
}
request.bodyPatterns[].containsSubstring match.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"contains": "orderId"
}
]
}
}
request.bodyPatterns[].contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"doesNotContain": "error"
}
]
}
}
request.bodyPatterns[].doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].matchesRegex match.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matches": "ORD-[0-9]+"
}
]
}
}
request.bodyPatterns[].matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"doesNotMatch": ".*test.*"
}
]
}
}
request.bodyPatterns[].doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"before": "now +1 days"
}
]
}
}
request.bodyPatterns[].afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"after": "2026-01-01T00:00:00Z"
}
]
}
}
request.bodyPatterns[].equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"equalToDateTime": "now"
}
]
}
}
request.bodyPatterns[].actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"actualFormat": "dd/MM/yyyy"
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"truncateExpected": "first second of minute"
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"truncateActual": "first second of minute"
}
]
}
}
request.bodyPatterns[].applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"bodyPatterns": [
{
"applyTruncationLast": true
}
]
}
}
request.bodyPatterns[].expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"bodyPatterns": [
{
"expectedOffset": 1
}
]
}
}
request.bodyPatterns[].expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"expectedOffsetUnit": "SECONDS"
}
]
}
}
request.bodyPatterns[].anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"anything": "anything"
}
]
}
}
request.bodyPatterns[].absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"bodyPatterns": [
{
"absent": true
}
]
}
}
request.bodyPatterns[].andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"bodyPatterns": [
{
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
]
}
}
request.bodyPatterns[].orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"bodyPatterns": [
{
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
]
}
}
request.bodyPatterns[].notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"bodyPatterns": [
{
"not": {
"contains": "test"
}
}
]
}
}
request.bodyPatterns[].matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesPathTemplate": "/orders/{orderId}"
}
]
}
}
request.bodyPatterns[].binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"binaryEqualTo": "SGVsbG8="
}
]
}
}
request.bodyPatterns[].binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesXml": "<order><id>42</id></order>"
}
]
}
}
request.bodyPatterns[].matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"matchesJson": {
"orderId": 42
}
}
]
}
}
request.bodyPatterns[].matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesGraphQL": "{ order(id: 42) { status } }"
}
]
}
}
request.bodyPatterns[].matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
]
}
}
request.bodyPatterns[].matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesSwiftField": {
"field": "20"
}
}
]
}
}
request.bodyPatterns[].matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
]
}
}
request.bodyPatterns[].matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
]
}
}
request.bodyPatterns[].matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesFixField": {
"field": "35"
}
}
]
}
}
request.bodyPatterns[].matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesFixField": {
"matches": "D"
}
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
]
}
}
request.bodyPatterns[].matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
]
}
}
request.bodyPatterns[].matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"equalTo": "1234567890"
}
}
]
}
}
request.bodyPatterns[].matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
]
}
}
request.bodyPatterns[].matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"greaterThan": 100
}
}
]
}
}
request.bodyPatterns[].matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
]
}
}
request.bodyPatterns[].matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"lessThan": 1000
}
}
]
}
}
request.bodyPatterns[].matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"bodyPatterns": [
{
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
]
}
}
request.bodyPatterns[].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": {
"bodyPatterns": [
{
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
]
}
}
request.multipartPatternsMultipart request body matching patterns.
[object]Example in context:
{
"request": {
"multipartPatterns": [
{
"name": "file",
"matchingType": "ANY",
"bodyPatterns": [
{
"contains": "invoice"
}
]
}
]
}
}
request.multipartPatterns[].nameName of the part, from its Content-Disposition header.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"name": "file"
}
]
}
}
request.multipartPatterns[].fileNameFile name of the part, from its Content-Disposition header.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"fileName": "invoice.pdf"
}
]
}
}
request.multipartPatterns[].matchingTypeALL: every part must match this pattern. ANY: at least one part must.
string"ALL", "ANY"Example in context:
{
"request": {
"multipartPatterns": [
{
"matchingType": "ANY"
}
]
}
}
request.multipartPatterns[].headersMatchers the part's headers must satisfy, by header name.
{name: matcher}equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"Content-Type": {
"equalTo": "application/pdf"
}
}
}
]
}
}
request.multipartPatterns[].headers.*Matcher for a multi-valued element (header, query or form parameter): a plain matcher on the single value, or hasExactly / includes over all values.
objectequalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsField, hasExactly, includesrequest.multipartPatterns[].headers.*.equalToExact string equality.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"equalTo": "application/json"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"caseInsensitive": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"equalToJson": {
"orderId": 42
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"ignoreArrayOrder": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"ignoreExtraElements": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"treatNullAsAbsent": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"schemaVersion": "V202012"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"equalToXml": "<order><id>42</id></order>"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"enablePlaceholders": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"placeholderOpeningDelimiterRegex": "\\[\\["
}
}
}
]
}
}
request.multipartPatterns[].headers.*.placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"placeholderClosingDelimiterRegex": "\\]\\]"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
}
}
]
}
}
request.multipartPatterns[].headers.*.ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"ignoreOrderOfSameNode": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"namespaceAwareness": "NONE"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesJsonPath": "$.orderId"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesXPath": "/order/id"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.containsSubstring match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"contains": "orderId"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"doesNotContain": "error"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesRegex match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matches": "ORD-[0-9]+"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"doesNotMatch": ".*test.*"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"before": "now +1 days"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"after": "2026-01-01T00:00:00Z"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"equalToDateTime": "now"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"actualFormat": "dd/MM/yyyy"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"truncateExpected": "first second of minute"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"truncateActual": "first second of minute"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"applyTruncationLast": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"expectedOffset": 1
}
}
}
]
}
}
request.multipartPatterns[].headers.*.expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"expectedOffsetUnit": "SECONDS"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"anything": "anything"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"absent": true
}
}
}
]
}
}
request.multipartPatterns[].headers.*.andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
}
}
]
}
}
request.multipartPatterns[].headers.*.orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
}
}
]
}
}
request.multipartPatterns[].headers.*.notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"not": {
"contains": "test"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesPathTemplate": "/orders/{orderId}"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"binaryEqualTo": "SGVsbG8="
}
}
}
]
}
}
request.multipartPatterns[].headers.*.binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesXml": "<order><id>42</id></order>"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesJson": {
"orderId": 42
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesGraphQL": "{ order(id: 42) { status } }"
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesSwiftField": {
"field": "20"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesFixField": {
"field": "35"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesFixField": {
"matches": "D"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"equalTo": "1234567890"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"greaterThan": 100
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"lessThan": 1000
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.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": {
"multipartPatterns": [
{
"headers": {
"name": {
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
}
}
]
}
}
request.multipartPatterns[].headers.*.hasExactlyThe header or parameter has exactly these values, one matching each matcher, in any order.
[matcher]Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"hasExactly": [
{
"equalTo": "red"
},
{
"equalTo": "blue"
}
]
}
}
}
]
}
}
request.multipartPatterns[].headers.*.includesThe header or parameter has, among its values, one matching each matcher.
[matcher]Example in context:
{
"request": {
"multipartPatterns": [
{
"headers": {
"name": {
"includes": [
{
"equalTo": "red"
}
]
}
}
}
]
}
}
request.multipartPatterns[].bodyPatternsMatchers the part's body must satisfy.
[matcher]equalTo, equalToJson, matchesJsonSchema, equalToXml, matchesJsonPath, matchesXPath, contains, doesNotContain, matches, doesNotMatch, before, after, equalToDateTime, anything, absent, and, or, not, matchesPathTemplate, binaryEqualTo, matchesXml, matchesJson, matchesGraphQL, matchesSwiftField, matchesFixField, matchesCicsFieldExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"contains": "invoice"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].equalToExact string equality.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"equalTo": "application/json"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].equalTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"equalTo": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].caseInsensitiveOption for equalTo.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"caseInsensitive": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].equalToJsonSemantic JSON equality. Inline JSON value, a string containing JSON, or a bodyFileName reference object.
string | object | arrayExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"equalToJson": {
"orderId": 42
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].ignoreArrayOrderOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"ignoreArrayOrder": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].ignoreExtraElementsOption for equalToJson / matchesJson.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"ignoreExtraElements": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].treatNullAsAbsentOption for equalToJson.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"treatNullAsAbsent": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesJsonSchemaValue must validate against the given JSON Schema (inline object, string, or bodyFileName reference object).
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesJsonSchema": {
"type": "object",
"required": [
"orderId"
]
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].schemaVersionOption for matchesJsonSchema (default V202012).
string"V4", "V6", "V7", "V201909", "V202012"Example in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"schemaVersion": "V202012"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].equalToXmlSemantic XML equality.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"equalToXml": "<order><id>42</id></order>"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].equalToXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"equalToXml": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].enablePlaceholdersOption for equalToXml.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"enablePlaceholders": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].placeholderOpeningDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"placeholderOpeningDelimiterRegex": "\\[\\["
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].placeholderClosingDelimiterRegexOption for equalToXml.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"placeholderClosingDelimiterRegex": "\\]\\]"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"exemptedComparisons": [
"NAMESPACE_URI",
"SCHEMA_LOCATION"
]
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].ignoreOrderOfSameNodeOption for equalToXml.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"ignoreOrderOfSameNode": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].namespaceAwarenessOption for equalToXml.
string"STRICT", "LEGACY", "NONE"Example in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"namespaceAwareness": "NONE"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesJsonPathJSONPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesJsonPath": "$.orderId"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesXPathXPath expression match: a string expression, an advanced {"expression": ..., <sub-matcher>} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesXPath": "/order/id"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].xPathNamespacesOption for matchesXPath: prefix to namespace URI.
{name: string}Example in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"xPathNamespaces": {
"ord": "http://example.com/orders"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].containsSubstring match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"contains": "orderId"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].contains.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"contains": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].doesNotContainNegative substring match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"doesNotContain": "error"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].doesNotContain.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"doesNotContain": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesRegex match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matches": "ORD-[0-9]+"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matches.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matches": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].doesNotMatchNegative regex match.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"doesNotMatch": ".*test.*"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].doesNotMatch.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"doesNotMatch": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].beforeDate-time before the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"before": "now +1 days"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].afterDate-time after the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"after": "2026-01-01T00:00:00Z"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].equalToDateTimeDate-time equality with the given ISO-8601 instant or now-offset expression.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"equalToDateTime": "now"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].actualFormatOption for before / after / equalToDateTime: format of the actual value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"actualFormat": "dd/MM/yyyy"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"truncateExpected": "first second of minute"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"truncateActual": "first second of minute"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].applyTruncationLastOption for before / after / equalToDateTime.
booleanExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"applyTruncationLast": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].expectedOffsetOption for before / after / equalToDateTime.
integerExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"expectedOffset": 1
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].expectedOffsetUnitOption for before / after / equalToDateTime: the unit of expectedOffset. One of the examples, in any case.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"expectedOffsetUnit": "SECONDS"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].anythingMatches any value. The operand string is ignored.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"anything": "anything"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].absentThe element must be absent. Canonically written as true; the operand value is ignored.
any JSONExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"absent": true
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].andAll nested matchers must match.
[matcher]Example in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"and": [
{
"contains": "order"
},
{
"doesNotContain": "test"
}
]
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].orAt least one nested matcher must match.
[matcher]Example in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"or": [
{
"equalTo": "GB"
},
{
"equalTo": "IE"
}
]
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].notThe nested matcher must not match.
matcherExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"not": {
"contains": "test"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesPathTemplateRFC 6570 path template match (string-value sub-matcher form; the request URL role serialises as urlPathTemplate instead).
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesPathTemplate": "/orders/{orderId}"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].binaryEqualToByte-for-byte equality with the Base64-decoded operand. Valid only as a direct entry of request.bodyPatterns or of a multipart part's bodyPatterns, not inside an "and", "or" or "not" matcher, although this schema accepts it wherever a matcher is.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"binaryEqualTo": "SGVsbG8="
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].binaryEqualTo.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"binaryEqualTo": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesXmlTraffic Parrot: XML match where element/attribute values may be regular expressions.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesXml": "<order><id>42</id></order>"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesXml.bodyFileNameName of a file under __files whose content is the matcher's value, in place of an inline value.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesXml": {
"bodyFileName": "requests/expected-order.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesJson": {
"orderId": 42
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesGraphQLTraffic Parrot: GraphQL query match. A query string, an {"operationName": ..., "variables": ...} object, or a bodyFileName reference object.
string | objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesGraphQL": "{ order(id: 42) { status } }"
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesSwiftFieldTraffic Parrot: match one field of a SWIFT MT message.
objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesSwiftField": {
"field": "20",
"matches": "REF[0-9]+"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesSwiftField.fieldSWIFT MT field tag to read, for example 20 (transaction reference).
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesSwiftField": {
"field": "20"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesSwiftField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesSwiftField": {
"matches": "REF[0-9]+"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesSwiftField": {
"bodyFileName": "requests/mt103-match.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesFixFieldTraffic Parrot: match one field of a FIX message.
objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesFixField": {
"field": "35",
"matches": "D"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesFixField.fieldFIX tag number to read, for example 35 (MsgType).
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesFixField": {
"field": "35"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesFixField.matchesRegular expression the tag's value must match.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesFixField": {
"matches": "D"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesFixField": {
"bodyFileName": "requests/fix-order-match.json"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsFieldTraffic Parrot: match one field of a CICS bridge request (IBM MQ, MQFMT_CICS) by its path in the request's JSON view (MQCIH.TransactionId, ProgramName, COMMAREA.ACCOUNT-NO, COMMAREA.TXN-ENTRY[0].TXN-AMOUNT with 0-based indices), with exactly one of equalTo, matches (a whole-value regular expression), greaterThan, greaterThanOrEqualTo, lessThan or lessThanOrEqualTo. Numbers compare as numbers.
objectExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO",
"equalTo": "1234567890"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"field": "COMMAREA.ACCOUNT-NO"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsField.equalToThe field's value equals this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"equalTo": "1234567890"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsField.matchesRegular expression the field's value must match.
stringExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"matches": "[0-9]{10}"
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsField.greaterThanThe field's numeric value is greater than this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"greaterThan": 100
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsField.greaterThanOrEqualToThe field's numeric value is greater than or equal to this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"greaterThanOrEqualTo": 100
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsField.lessThanThe field's numeric value is less than this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"lessThan": 1000
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].matchesCicsField.lessThanOrEqualToThe field's numeric value is less than or equal to this.
string | numberExample in context:
{
"request": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"lessThanOrEqualTo": 1000
}
}
]
}
]
}
}
request.multipartPatterns[].bodyPatterns[].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": {
"multipartPatterns": [
{
"bodyPatterns": [
{
"matchesCicsField": {
"bodyFileName": "requests/cics-account-match.json"
}
}
]
}
]
}
}
request.customMatcherCustom request matcher, e.g. name "requestMatchers" with a parameters.matchesScript Handlebars script, or parameters.matchesValidBearerToken {"oauth2Mock": "<name>"} to require a valid bearer token from a scaffolded OAuth2 mock. Several keys must all match.
objectExample in context:
{
"request": {
"customMatcher": {
"name": "my-matcher",
"parameters": {
"threshold": 5
}
}
}
}
request.customMatcher.nameName the custom request matcher extension registers itself under.
stringExample in context:
{
"request": {
"customMatcher": {
"name": "my-matcher"
}
}
}
request.customMatcher.parametersParameters passed to the custom matcher. Their keys depend on the matcher.
objectExample in context:
{
"request": {
"customMatcher": {
"parameters": {
"threshold": 5
}
}
}
}
responseResponse definition. Use at most one of body / jsonBody / base64Body / bodyFileName.
objectExample in context:
{
"response": {
"status": 0,
"jsonBody": {
"id": "42"
}
}
}
response.statusThe gRPC status code: 0 OK, or the call fails with 1 CANCELLED, 2 UNKNOWN, 3 INVALID_ARGUMENT, 4 DEADLINE_EXCEEDED, 5 NOT_FOUND, 6 ALREADY_EXISTS, 7 PERMISSION_DENIED, 8 RESOURCE_EXHAUSTED, 9 FAILED_PRECONDITION, 10 ABORTED, 11 OUT_OF_RANGE, 12 UNIMPLEMENTED, 13 INTERNAL, 14 UNAVAILABLE, 15 DATA_LOSS or 16 UNAUTHENTICATED, with the response body as its description. 200, the default, is the deprecated form of OK; any other number would reach the client as UNKNOWN.
integer0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 200Example in context:
{
"response": {
"status": 0
}
}
response.statusMessageHTTP status message.
stringExample in context:
{
"response": {
"statusMessage": "OK"
}
}
response.bodyThe response message as JSON text, or the error description when status is an error code (anything but 0 or 200). May contain Handlebars templates when the response transformer is enabled.
stringExample in context:
{
"response": {
"body": "{\"orderId\": 42, \"status\": \"open\"}"
}
}
response.jsonBodyThe response message as inline JSON, or the error description when status is an error code (anything but 0 or 200).
any JSONExample in context:
{
"response": {
"jsonBody": {
"orderId": 42,
"status": "open"
}
}
}
response.base64BodyResponse body as a Base64-encoded string (for binary content).
stringExample in context:
{
"response": {
"base64Body": "SGVsbG8gd29ybGQ="
}
}
response.bodyFileNamePath to the file containing the response body, relative to the __files directory.
stringExample in context:
{
"response": {
"bodyFileName": "orders/open-orders.json"
}
}
response.headersResponse headers: name to string value or array of string values.
{name: string | array}Example in context:
{
"response": {
"headers": {
"Content-Type": "application/json"
}
}
}
response.additionalProxyRequestHeadersExtra headers added to the request when proxying.
{name: string | array}Example in context:
{
"response": {
"additionalProxyRequestHeaders": {
"X-Forwarded-By": "traffic-parrot"
}
}
}
response.removeProxyRequestHeadersHeader names removed from the request when proxying.
[string]Example in context:
{
"response": {
"removeProxyRequestHeaders": [
"Authorization"
]
}
}
response.fixedDelayMillisecondsFixed delay in milliseconds before returning the response.
integerExample in context:
{
"response": {
"fixedDelayMilliseconds": 250
}
}
response.delayDistributionRandom delay distribution, discriminated by type.
objectExample in context:
{
"response": {
"delayDistribution": {
"type": "lognormal",
"median": 80,
"sigma": 0.4
}
}
}
response.delayDistribution.typelognormal: a random delay drawn from a log-normal distribution. uniform: a random delay between lower and upper. fixed: the same delay every time.
string"lognormal", "uniform", "fixed"Example in context:
{
"response": {
"delayDistribution": {
"type": "lognormal"
}
}
}
response.delayDistribution.medianMedian delay in milliseconds. Only with type "lognormal".
numberExample in context:
{
"response": {
"delayDistribution": {
"median": 80
}
}
}
response.delayDistribution.sigmaStandard deviation of the underlying normal distribution. A larger value gives a longer tail of slow responses. Only with type "lognormal".
numberExample in context:
{
"response": {
"delayDistribution": {
"sigma": 0.4
}
}
}
response.delayDistribution.maxValueLongest delay in milliseconds. A longer sampled delay is cut to this. Only with type "lognormal".
numberExample in context:
{
"response": {
"delayDistribution": {
"maxValue": 2000
}
}
}
response.delayDistribution.lowerShortest delay in milliseconds. Only with type "uniform".
integerExample in context:
{
"response": {
"delayDistribution": {
"lower": 50
}
}
}
response.delayDistribution.upperLongest delay in milliseconds. Only with type "uniform".
integerExample in context:
{
"response": {
"delayDistribution": {
"upper": 150
}
}
}
response.delayDistribution.millisecondsDelay in milliseconds. Only with type "fixed".
integerExample in context:
{
"response": {
"delayDistribution": {
"milliseconds": 250
}
}
}
response.chunkedDribbleDelayDribble the response body to the client in chunks over totalDuration milliseconds.
objectExample in context:
{
"response": {
"chunkedDribbleDelay": {
"numberOfChunks": 5,
"totalDuration": 1000
}
}
}
response.chunkedDribbleDelay.numberOfChunksNumber of chunks the response body is split into.
integerExample in context:
{
"response": {
"chunkedDribbleDelay": {
"numberOfChunks": 5
}
}
}
response.chunkedDribbleDelay.totalDurationTime in milliseconds over which the chunks are sent.
integerExample in context:
{
"response": {
"chunkedDribbleDelay": {
"totalDuration": 1000
}
}
}
response.faultFault to inject instead of a well-formed response. Values are case-sensitive, including the lowercase ms/s suffixes.
string"CONNECTION_RESET_BY_PEER", "EMPTY_RESPONSE", "MALFORMED_RESPONSE_CHUNK", "RANDOM_DATA_THEN_CLOSE", "DRIP_BYTE_EVERY_100ms", "DRIP_BYTE_EVERY_1s", "DRIP_BYTE_EVERY_10s", "INCORRECT_SMALL_CONTENT_LENGTH", "CLOSE_CONNECTION_AFTER_HALF_RESPONSE"Example in context:
{
"response": {
"fault": "CONNECTION_RESET_BY_PEER"
}
}
response.proxyBaseUrlBase URL to proxy matched requests to instead of serving a stubbed response.
stringExample in context:
{
"response": {
"proxyBaseUrl": "https://api.example.com"
}
}
response.proxyUrlPrefixToRemoveURL prefix removed from the request path before proxying.
stringExample in context:
{
"response": {
"proxyUrlPrefixToRemove": "/proxy"
}
}
response.transformersResponse transformer extension names to apply.
[string]Example in context:
{
"response": {
"transformers": [
"response-template"
]
}
}
response.transformerParametersParameters passed to the response transformers. Any key is accepted here.
objectExample in context:
{
"response": {
"transformerParameters": {
"discount": 10
}
}
}
response.fromConfiguredStubWhether this response came from a configured stub. Traffic Parrot writes this flag; it is not needed when writing a mapping.
booleanExample in context:
{
"response": {
"fromConfiguredStub": true
}
}