Skip to main content Skip to complementary content

Creating a scenario

Create a sequence of requests.

The SCENARIOS perspective is designed to help with API tests creation and execution. Additionally to the ability to run any request container, this perspective offers an auto-save mechanism. Any change is automatically saved and shared with your team.

Procedure

  1. Go to the SCENARIOS tab.
  2. In the left panel, click the menu to the left of the test project in which you want to create your scenario.
    You can also create a scenario in a service.
  3. Click Add a scenario.
    Availability-noteTATFree
    Free users are limited to one scenario. If you have already created a scenario, this option is no longer available. If you want to create a new scenario, you need to delete the existing one.
  4. Name your scenario and add requests by clicking Add a new request or Add existing requests.
    If you click Add existing requests, a dialog box opens and allows you to select requests from any API project available.
  5. If needed, you can move a request in the scenario by clicking the arrows to the left of the Edit request button.
  6. You can also insert new requests anywhere in the scenario by clicking the + button between two requests.
  7. You can define a number of attempts to send a request after it fails. Click Edit request > Retry on failure and set the number of attempts and the interval between each attempt.
    For example, set the number of attempts to two and the interval between each attempt to ten seconds.
    Information noteNote: This option is only available in the SCENARIOS perspective.
  8. Once you have added all your requests, click the play button to launch the scenario.

Results

Your scenario launches your requests in the order defined. If a request fails, the scenario stops and is marked as failed. You can see the responses by clicking Edit request or by clicking the name of the request in the left panel.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here