Steps Reference

All Steps — Quick Reference

A flat table of every step signature in the library.

{httpMethod} can be: GET, POST, PUT, PATCH, DELETE.
📎 = requires a data table or doc-string body. See the linked page for the exact shape.

Given

Step	Details
that the following users and tokens are existing 📎	Given — Authentication
that the user is {string}	Given — Authentication
that the Bearer token is {string}	Given — Authentication
that a bearer token without scopes is used	Given — Authentication
that all URLs are relative to {string}	Given — Request Setup
that the API path is {string}	Given — Request Setup
that the file {string} is used as the body	Given — Request Setup
that the body of the request is 📎	Given — Request Setup
I set the value of the previously given body property {string} to {string}	Given — Request Setup
that all file paths are relative to {string}	Given — Request Setup
I set the header {string} to {string}	Given — Request Setup
I set the header {string} to {string} prefixed by {string}	Given — Request Setup
that the context contains the key {string} with the value {string}	Given — Context
that the context contains the following 'key' and 'value' pairs 📎	Given — Context
that the stored data in the scenario context map has been reset	Given — Context
that the request body in the scenario context map has been reset	Given — Context
that the response JSON can contain arrays with extra elements	JSON-Unit
that the response JSON can contain arrays in different order	JSON-Unit
that the response JSON can contain extra fields	JSON-Unit
that a request polls every {int} seconds for {int} times	When — Polling
that a requests polls every {int} seconds	When — Polling
that a requests polls for {int} times	When — Polling
that a date {int} days in the past is stored as {string}	Common — Dates
that a date {int} months in the past is stored as {string}	Common — Dates
that a date {int} years in the past is stored as {string}	Common — Dates
that a date {int} days in the future is stored as {string}	Common — Dates
that a date {int} months in the future is stored as {string}	Common — Dates
that a date {int} years in the future is stored as {string}	Common — Dates
that the database was initialized with the liquibase file {string}	Common — Database
that the SQL statements from the SQL file {string} was executed	Common — Database
that a proxy with host {string} and port {string} is configured	Configuration
that the file {string} is stored as "FORM_FILE"	When — REST Calls

When

Step	Details
executing a {httpMethod} call with previously given URI and body	When — REST Calls
executing an authorized {httpMethod} call with previously given URI and body	When — REST Calls
executing a {httpMethod} call to {string} with previously given body	When — REST Calls
executing an authorized {httpMethod} call to {string} with previously given body	When — REST Calls
executing a {httpMethod} call to {string} with the body from file {string}	When — REST Calls
executing an authorized {httpMethod} call to {string} with the body from file {string}	When — REST Calls
executing a {httpMethod} call with previously given URI	When — REST Calls
executing an authorized {httpMethod} call with previously given URI	When — REST Calls
executing a {httpMethod} call to {string}	When — REST Calls
executing an authorized {httpMethod} call to {string}	When — REST Calls
executing a {httpMethod} call with previously given API path, body and these dynamic 'URI Elements' replaced with the 'URI Values' 📎	When — REST Calls
executing an authorized {httpMethod} call with previously given API path, body and these dynamic 'URI Elements' replaced with the 'URI Values' 📎	When — REST Calls
executing a {httpMethod} call with previously given API path and these dynamic 'URI Elements' replaced with the 'URI Values' 📎	When — REST Calls
executing an authorized {httpMethod} call with previously given API path and these dynamic 'URI Elements' replaced with the 'URI Values' 📎	When — REST Calls
executing a form-data POST call to {string} with the fields 📎	When — REST Calls
executing an authorized form-data POST call to {string} with the fields 📎	When — REST Calls
executing a {httpMethod} poll request until the response code is {int}	When — Polling
executing an authorized {httpMethod} poll request until the response code is {int}	When — Polling
executing a {httpMethod} poll request until the response code is {int} and the body is equal to file {string}	When — Polling
executing an authorized {httpMethod} poll request until the response code is {int} and the body is equal to file {string}	When — Polling
executing a {httpMethod} poll request until the response code is {int} and the body is equal to 📎	When — Polling
executing an authorized {httpMethod} poll request until the response code is {int} and the body is equal to 📎	When — Polling

Then

Step	Details
I ensure that the status code of the response is {int}	Then — Validation
I ensure that the body of the response is equal to the file {string}	Then — Validation
I ensure that the body of the response is equal to 📎	Then — Validation
I ensure that the response code is {int} and the body is equal to 📎	Then — Validation
I ensure that the response code is {int} and the body is equal to the file {string}	Then — Validation
I ensure that the body of the response contains a field {string} with the value {string}	Then — Validation
I ensure that the body of the response contains the following fields and values 📎	Then — Validation
I ensure, that the header {string} is equal to {string}	Then — Validation
I ensure that the execution time is less than {long} ms	Then — Timing
I wait for {int} ms	Then — Timing
I store the string of the field {string} in the context {string} for later usage	Then — Context
I ensure that the result of the query of the file {string} is equal to the CSV file {string}	Common — Database