Test suites

Deploy a shared test suite to a community's domain.

Changed on
post/testsuite/deployShared

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/testsuite/deployShared
  • Auth: API key in header ITB_API_KEY

Request body

ignoreWarningsboolean

Whether test suite validation warnings should be ignored.

replaceTestHistoryboolean

Whether the test history linked to the test suite's test cases should be reset. This is the default setting to consider if no test case specific options are defined.

updateSpecificationboolean

Whether the test suite's metadata should be updated using the provided test suite's content.

showIdentifiersboolean

Whether to return the test suite's contained and related identifiers upon successful deployment. These identifiers would be referenced when executing the test suite's tests through the REST API.

testSuitestring base64

The shared test suite archive to deploy provided as a Base64-encoded string. Mutually exclusive with 'testSuiteUri'.

testSuiteUristring uri

The URI from which to read the shared test suite archive. The server will fetch the archive from this address. Mutually exclusive with 'testSuite'.

Response

Test suite deployed

completedboolean required

Whether or not the deployment was completed.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the new optional request property /

    • info

      the request property / became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 433b3c0ae6d4Revision changes
    • breaking

      the request property / became required

    • warning

      removed the request property /

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status