POST/Start Test Run Method
This 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
| Parameter | Type | Description |
|---|---|---|
| Series | String |
The name of the series to put the results of this test run into |
| Notes | String | Any notes to add to the test run (optional) |
| workspaceProtectionPassword | String | The workspace protection password (only required if a password has been set for this workspace) |
| pollInjectorInterval | Integer | The interval in milliseconds at which each injector will send monitoring data back to the test controller server (optional) |
| fileTransferQueueSize | Integer |
The maximum number of injectors to attempt to transfer files to concurrently (optional) |
| fileRetrievalQueueSize | Integer | The maximum number of injectors to retrieve files from concurrently (optional) |
| maxEvents | Integer | The maximum number of errors/warnings to queue on each injector (optional) |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| dataConfigurationCheck | Object |
Whether or not the test data was configured correctly |
| sourceCodeCheck | Object | Whether or not the project has been built and is up to date |
| injectorConfigurationCheck | Object | Whether or not all injectors have been configured correctly |
| workspaceProtectionPasswordCheck | Object | Whether the provided workspace protection password is correct |
| licenseCheck | Object | Whether or not you have sufficient licenses to run the test |
| injectorRunningCheck | Object | Whether 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
{
"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
},
"workspaceProtectionPasswordCheck": {
"message": "No workspace protection password is required",
"success": true
},
"licenseCheck": {
"message": "License is valid",
"success": true
},
"injectorRunningCheck": {
"localhost": {
"message": "Injector will be started automatically when the test is started.",
"success": true
}
}
}
Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2022 Eggplant