State

Get all scenarios

get/v1/mock-apis/{mockApiId}/scenarios

Request

Base URL
https://wmc.wiremockapi.cloud
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/wiremock/apis/wiremock-cloud/docs/v1/mock-apis/:mockApiId/scenarios/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

detail'summary'

When set to summary, returns a lightweight view of each scenario containing only its name and current state, omitting stub mappings, possible states, and IDs. Any other value (or omitting the parameter) returns the full scenario representation.

Response

All scenarios

Example response

{
  "scenarios": [
    {
      "id": "c8d249ec-d86d-48b1-88a8-a660e6848042",
      "name": "my_scenario",
      "possibleStates": [
        "Started",
        "state_1",
        "state_2"
      ],
      "state": "state_2"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.