Diagnostic Test Objects

A diagnostic test performs a series of library actions to evaluate the status of the library or to demonstrate a feature.

The library provides a set of known diagnostics tests. A diagnostic test is a test the library can perform on itself. A user can initiate a diagnostic test, which will create a request. This request can be queried to see the status and results of the test.

The runDiagnosticTest() method can then be used to initiate the tests.

Tests are typically executed in the background. The async parameter on the runDiagnosticTest() method controls when the runDiagnosticTest() call will return. Starting a test returns a RequestDto for the test run. You can retrieve the status of the test run and its final results using the Request ID from the RequestDto returned when you started the test.

DiagnosticTestDto

Provides information about a diagnostic test.

• string name - string name for the test.

• string description - string description of the test.

• DiagnosticTestParameterDto testParameters - the parameters used to define the test.

DiagnosticTestParameterDto

Describes the test specific parameter.

• string name - name for the parameter.

• string description - description for the test parameter.

• string type - the type of parameter: BOOLEAN, NUMBER, STRING

• anyType value - not used.