GET
/
v1
/
mock-apis
/
{mockApiId}
/
mappings
/
{stubMappingId}

Authorizations

Authorization
string
headerrequired

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

stubMappingId
string
required

The UUID of stub mapping

Response

200 - application/json
id
string

This stub mapping's unique identifier

uuid
string

Alias for the id

name
string

The stub mapping's name

request
object
response
object
persistent
boolean

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

priority
integer

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

scenarioName
string

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

requiredScenarioState
string

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

newScenarioState
string

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

postServeActions
object

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

serveEventListeners
object[]

The list of serve event listeners

metadata
object

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

Import stub mappingsUpdate a stub mapping