Find stub mappings matching metadata

POST

mock-apis

{mockApiId}

mappings

find-by-metadata

curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/mappings/find-by-metadata \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "matchesJsonPath": {
    "expression": "$.outer",
    "equalToJson": "{ \"inner\": 42 }"
  }
}'

{
  "meta": {
    "total": 2
  },
  "mappings": [
    {
      "id": "76ada7b0-49ae-4229-91c4-396a36f18e09",
      "uuid": "76ada7b0-49ae-4229-91c4-396a36f18e09",
      "request": {
        "method": "GET",
        "url": "/search?q=things",
        "headers": {
          "Accept": {
            "equalTo": "application/json"
          }
        }
      },
      "response": {
        "status": 200,
        "jsonBody": [
          "thing1",
          "thing2"
        ],
        "headers": {
          "Content-Type": "application/json"
        }
      }
    },
    {
      "request": {
        "method": "POST",
        "urlPath": "/some/things",
        "bodyPatterns": [
          {
            "equalToXml": "<stuff />"
          }
        ]
      },
      "response": {
        "status": 201
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

mockApiId

string

required

The ID of the Mock API

Required string length: 5 - 10

Example:

"jjl8y"

Body

application/json

equalTo

string

required

caseInsensitive

boolean

equalTo

string

required

caseInsensitive

boolean

binaryEqualTo

string

required

A base64 encoded string used to describe binary data.

contains

string

required

doesNotContain

string

required

matches

string

required

doesNotMatch

string

required

not

object

required

before

string

required

Example:

"now +3 days"

actualFormat

string

Example:

"yyyy-MM-dd"

truncateExpected

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

truncateActual

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

after

string

required

Example:

"now +3 days"

actualFormat

string

Example:

"yyyy-MM-dd"

truncateExpected

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

truncateActual

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

equalToDateTime

string

required

Example:

"now +3 days"

actualFormat

string

Example:

"yyyy-MM-dd"

truncateExpected

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

truncateActual

enum<string>

Available options:

first second of minute,

first minute of hour,

first hour of day,

first day of month,

first day of next month,

last day of month,

first day of year,

first day of next year,

last day of year

Example:

"first day of month"

equalToJson

string

required

Example:

"{ \"message\": \"hello\" }\n"

ignoreExtraElements

boolean

ignoreArrayOrder

boolean

matchesJsonPath

required

Example:

"$.name"

equalToXml

string

required

Example:

"<amount>123</amount>"

enablePlaceholders

boolean

placeholderOpeningDelimiterRegex

string

Example:

"["

placeholderClosingDelimiterRegex

string

Example:

"]"

matchesXPath

required

Example:

"//Order/Amount"

xPathNamespaces

object

matchesJsonSchema

required

Example:

"//Order/Amount"

xPathNamespaces

object

absent

boolean

required

and

object[]

required

object[]

required

hasExactly

object[]

required

includes

object[]

required

Response

200 - application/json

Matched stub mappings

mappings

object[]

mappings.id

string

This stub mapping's unique identifier

mappings.uuid

string

Alias for the id

mappings.name

string

The stub mapping's name

mappings.request

object

mappings.request.scheme

enum<string>

The scheme (protocol) part of the request URL

Available options:

http,

https

mappings.request.host

string

The hostname part of the request URL

mappings.request.port

integer

The HTTP port number of the request URL

Required range: 1 <= x <= 65535

mappings.request.method

string

The HTTP request method e.g. GET

mappings.request.url

string

The path and query to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

mappings.request.urlPath

string

The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

mappings.request.urlPathPattern

string

The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

mappings.request.urlPattern

string

The path and query regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

mappings.request.pathParameters

object

Path parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form. Can only be used when the urlPathPattern URL match type is in use and all keys must be present as variables in the path template.

mappings.request.queryParameters

object

Query parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form

mappings.request.formParameters

object

application/x-www-form-urlencoded form parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form

mappings.request.headers

object

Header patterns to match against in the <key>: { "<predicate>": "<value>" } form

mappings.request.basicAuthCredentials

object

Pre-emptive basic auth credentials to match against

mappings.request.cookies

object

Cookie patterns to match against in the <key>: { "<predicate>": "<value>" } form

mappings.request.bodyPatterns

object[]

Request body patterns to match against in the <key>: { "<predicate>": "<value>" } form

mappings.request.customMatcher

object

Require the state of the Mock API to match the provided patterns. More information on this feature can be found here.

mappings.request.multipartPatterns

object[]

Multipart patterns to match against headers and body.

Example:

"{\n \"urlPath\" : \"/charges\",\n \"method\" : \"POST\",\n \"headers\" : {\n \"Content-Type\" : {\n \"equalTo\" : \"application/json\"\n }\n }\n"

mappings.response

object

mappings.response.status

integer

The HTTP status code to be returned

mappings.response.statusMessage

string

The HTTP status message to be returned

mappings.response.headers

object

Map of response headers to send

mappings.response.additionalProxyRequestHeaders

object

Extra request headers to send when proxying to another host.

mappings.response.removeProxyRequestHeaders

string[]

Request headers to remove when proxying to another host.

mappings.response.body

string

The response body as a string. Only one of body, base64Body, jsonBody or bodyFileName may be specified.

mappings.response.base64Body

string

A base64 encoded string used to describe binary data.

mappings.response.jsonBody

any

The response body as a JSON object. Only one of body, base64Body, jsonBody or bodyFileName may be specified.

mappings.response.bodyFileName

string

The path to the file containing the response body, relative to the configured file root. Only one of body, base64Body, jsonBody or bodyFileName may be specified.

Example:

"user-profile-responses/user1.json"

mappings.response.fault

enum<string>

The fault to apply (instead of a full, valid response).

Available options:

CONNECTION_RESET_BY_PEER,

EMPTY_RESPONSE,

MALFORMED_RESPONSE_CHUNK,

RANDOM_DATA_THEN_CLOSE

mappings.response.fixedDelayMilliseconds

integer

Number of milliseconds to delay be before sending the response.

mappings.response.delayDistribution

object

The delay distribution. Valid property configuration is either median/sigma/type or lower/type/upper.

mappings.response.chunkedDribbleDelay

object

The parameters for chunked dribble delay - chopping the response into pieces and sending them at delayed intervals

mappings.response.fromConfiguredStub

boolean

Read-only flag indicating false if this was the default, unmatched response. Not present otherwise.

mappings.response.proxyBaseUrl

string

The base URL of the target to proxy matching requests to.

mappings.response.proxyUrlPrefixToRemove

string

A path segment to remove from the beginning in incoming request URL paths before proxying to the target.

mappings.response.transformerParameters

object

Parameters to apply to response transformers.

mappings.response.transformers

string[]

List of names of transformers to apply to this response.

mappings.persistent

boolean

Indicates that the stub mapping should be persisted immediately on create/update/delete and survive resets to default.

mappings.priority

integer

This stub mapping's priority relative to others. 1 is highest.

Required range: x >= 1

mappings.scenarioName

string

The name of the scenario that this stub mapping is part of

mappings.requiredScenarioState

string

The required state of the scenario in order for this stub to be matched.

mappings.newScenarioState

string

The new state for the scenario to be updated to after this stub is served.

mappings.postServeActions

object

A map of the names of post serve action extensions to trigger and their parameters.

mappings.serveEventListeners

object[]

The list of serve event listeners

Operations to alter the state of your mock API. More information on this feature can be found here.

mappings.metadata

object

Arbitrary metadata to be used for e.g. tagging, documentation. Can also be used to find and remove stubs.

Users

Mock APIs

Teams

Organisations

Security

Data sources

Database connections

Usage

Access control

Stub Mappings

Requests

Recordings

State

OpenAPI

Imports

Find stub mappings matching metadata

Authorizations

Path Parameters

Body

Response