You can run three types of functional test:

Run a regression test

Regression tests check whether the changes didn't cause problems in other places of the configuration.

  1. Create a test suite with associated config version. You can either:
  2. If you have the test suite already created, run the List test suites operation and store the testSuiteId of the test suite you want to run the test for.
  3. Submit a test run with the configVersionExecutions array within the functional object. Provide all required members. Store the returned testRunId.
  4. Run the Get a test run operation using the stored testRunId to check the results.

Run a test for a test suite

If you want to execute a set of test cases, you can run the test for a test suite.

  1. Create a test suite. You can either:
  2. If you have the test suite already created, run the List test suites operation and store the testSuiteId of the test suite you want to run the test for.
  3. Submit a test run with the testSuiteExecutions array within the functional object. Provide all required members. Store the returned testRunId.
  4. Run the Get a test run operation using the stored testRunId to check the results.

Run a test for a functional test case

If you don't need to run test for a config version, or test suite, you can also execute single functional test case.

  1. Submit a test run with the testCaseExecution object within the functional object. Provide testRequest, condition, and clientProfile and other required members. Store the returned testRunId.
  2. Run the Get a test run operation using the stored testRunId to check the results.