Create a Test Suite

API Explorer: /multi-tests

To create a test suite:

  1. Create the multi-test object with a POST to the multi-test endpoint (see sample code).
  2. Capture the collectionId returned as id from the response.
  3. Add tests to the test suite by using the collectionId, which is explained in the Add Tests to Test Suite section.

See Update a Test Suite for more information.

Once created, a test suite can be executed as part of any of your workflows, so make sure to save the id for later use. The collectionId will be used as a parameter to identify the test suite.

Create a Test Suite

curl 'https://a.blazemeter.com/api/v4/multi-tests' \
	-X POST \
	-H 'Content-Type: application/json' \
	--user 'api_key_id:api_key_secret' \
	-d '{"collectionType":"functionalTestSuite","name":"API Created Functional Suite Test","projectId":123456}'

Create a Test Suite Request Attributes

Attributes

  • collectionTypestring

    required

    The type of multi test. Always will be functionalTestSuite

  • namestring

    required

    The name of the test suite

  • projectIdinteger

    required

    The projectId to which this test suite belongs

The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

Create a Test SuiteCreate a Test Suite POST Body (JSON) 

{
    "collectionType": "functionalTestSuite",
    "name": "API Created Functional Suite Test",
    "projectId": 167798
}

Create a Test Suite Response Attributes

For the full details of all the attributes for the test suite (multi-test), you can visit The Multi-Test Object.

Response201 Created 

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 12345678,
        "name": "API Created Functional Suite Test",
        "collectionType": "functionalTestSuite",
        "userId": 123456,
        "created": 1591994426,
        "updated": 1591994426,
        "creatorClientId": "api",
        "shouldSendReportEmail": false,
        "projectId": 123456,
        "filesToSplit": [],
        "dataFiles": []
    },
    "request_id": "5ee3e83a4f1fa"
}