Skip to main content

Assert Contains

Legacy Documentation
You're viewing legacy documentation for API Fortress (deployed via an on-premises container). To view documentation for the new SaaS version of API Fortress now known as Sauce Labs API Testing and Monitoring (with Sauce Connect tunnels) see API Testing on the Sauce Labs Cloud.

This assertion is used to check if the element described by the expression contains a specific substring. For example, to test the word Uber is in Uber's product names (UberX, UberBlack, UberPool).

Parameters

NameType/ValueRequired
ExpressionExpressionYes
ValueStringYes
Mode'all' or 'one'No
Level'error' or 'warning'No
Modifier'not'No
Execute if item exists'true' or 'false'No
Stop test if fails'true' or 'false'No
CommentStringNo
  • Expression: The path to the element we want to operate on (e.g., payload.ProductID). See Expression for more details.
  • Value: The value we want to compare the expression to.
  • Mode: Specify if all the same elements in the payload should match the assertion (‘all’) or if only one element (‘one’) is enough.
  • Level: Specifies, when the assertion fails, whether it should be considered an error or just a warning.
  • Modifier: The assertion is considered verified if it does not pass.
  • Execute if item exists: The assertion is evaluated only if the element exists. This is useful when the element does not always exist.
  • Stop test if fails: The test will be immediately stopped if the assertion fails.
  • Comment: Add comment messages in the form of a string data type.
note

A warning will not trigger alerts (such as email or text messages).

Code View Examples

<assert-contains expression=”data.url” value=”domain.com”/>
<assert-contains expression=”data.id” value=”${id}”/>