API Reference

model

summary
public

The DELETE method requests that the origin server remove the association between the target resource and its current functionality.

public

The HTTP GET method requests a representation of the specified resource.

public abstract

HTTP Request sent by the Actor using the Send Interaction

public

The HTTP HEAD method requests the headers that are returned if the specified resource would be requested with an HTTP GET method.

public

The OPTIONS method requests information about the communication options available for the target resource, at either the origin server or an intervening intermediary.

public

The PATCH method requests that a set of changes described in the request entity be applied to the resource identified by the resourceUri.

public

The HTTP POST method requests that the origin server accepts the entity enclosed in the request as a new subordinate of the resource identified by the resourceUri.

public

The PUT method requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

screenplay/abilities

summary
public

An Ability that enables the Actor to call a HTTP API.

screenplay/interactions

summary
public

Changes configuration of the CallAnApi Ability the Actor executing this Interaction has been configured with.

public
this class was deprecated. Use ChangeApiConfig.setUrlTo(newUrl) instead

Changes the base URL the CallAnApi Ability has been configured with.

public

C Send

Sends a HTTPRequest to a specified url.

screenplay/questions

summary
public

Provides access to the properties of the last AxiosResponse object, cached on the CallAnApi Ability.