Skip to main content

Start Test Run

This Eggplant Performance Test Controller REST method starts a new test run.

URL

/test_controller/api/1.0/<workspace>/<project>/<test>/start

HTTP Method

POST: Starts a new test run

POST Data Parameters

ParameterTypeDescription
seriesStringThe name of the series to put the results of this test run into.
notesStringAny notes to add to the test run. (optional)
workspaceProtectionPasswordStringThe workspace protection password (only required if a password has been set for this workspace).
pollInjectorIntervalIntegerThe interval in milliseconds at which each injector will send monitoring data back to the test controller server (optional).
fileTransferQueueSizeIntegerThe maximum number of injectors to attempt to transfer files to concurrently (optional).
fileRetrievalQueueSizeIntegerThe maximum number of injectors to retrieve files from concurrently (optional).
maxEventsIntegerThe maximum number of errors/warnings to queue on each injector (optional).

Response Parameters

ParameterTypeDescription
workspaceProtectionPasswordCheckObjectWhether the provided workspace protection password is correct.
jmeterConfigurationCheckObjectWhether or not JMeter is required for this test.
dataConfigurationCheckObjectWhether or not the test data was configured correctly.
sourceCodeCheckObjectWhether or not the project has been built and is up to date.
injectorConfigurationCheckObjectWhether or not all injectors have been configured correctly.
licenseCheckObjectWhether or not you have sufficient licenses to run the test.
injectorRunningCheckObjectWhether or not all remote injectors can be contacted.

Example Request

http://localhost:5001/test_controller/api/1.0/Demo%20Workspace/Demo/demoScript/start
POST Data
{
"series": "Default Series"
}

Example Response

{
"workspaceProtectionPasswordCheck": {
"message": "No workspace protection password is required",
"success": true
},
"jmeterConfigurationCheck": {
"message": "JMeter not required for this test",
"success": true
},
"dataConfigurationCheck": {
"message": "Data configuration OK",
"success": true
},
"sourceCodeCheck": {
"message": "Project has been built and is up to date",
"success": true
},
"injectorConfigurationCheck": {
"message": "Injector configuration is valid",
"success": true
},
"licenseCheck": {
"message": "License is valid",
"success": true
},
"injectorRunningCheck": {
"localhost": {
"message": "Injector will be started automatically when the test is started.",
"success": true
}
}
}