Test plans

Choose your language:

Test plans define the criteria and tests used for a system.

client.testPlans.generate(systemId, options)

Start asynchronous test plan generation for a system.

SDK	client.test_plans.generate(system_id, options=None, idempotency_key=None)
Returns	JobRef

Parameters:

Location	Parameter	Type	Required	Default	Description
Path	system_id	string	Required	—	System UUID.
Body	criteria	list[str]	Optional	—	Criterion ids to include.
Body	nb_tests	integer	Optional	3	Number of tests per criterion. Minimum 1, maximum 50.
Body	lang	string	Optional	en	Generation language.
Body	force_new_plan	boolean	Optional	false	Force a new plan instead of reusing an existing one.
SDK option	idempotency_key	string	Optional	—	Sent as the Idempotency-Key header.

client.testPlans.list(systemId)

Read the active and latest test plans for a system.

SDK	client.test_plans.list(system_id)
Returns	TestPlansOverview

Parameters:

Location	Parameter	Type	Required	Description
Path	system_id	string	Required	System UUID.

client.testPlans.get(planId)

Read one test plan.

SDK	client.test_plans.get(plan_id)
Returns	TestPlan

Parameters:

Location	Parameter	Type	Required	Description
Path	plan_id	string	Required	Test plan UUID.