Update a Multi-Test
API Explorer: /collections/{collectionId}
To update a multi-test, use PUT to change the provided configuration for a given test (you need to know the collectionId). The sample code updates a multi-test with an ID of 12345678 (the 12345678 is contained in the URL) with a new description, This is an update.. The sample code updates the test created in the Create a Multi-Test section.
If you do not know the collectionId of the test to update, use List Multi-Tests to return a list of your created tests.
See the Multi-Test Object for all parameters that you can modify.
Update a Multi-Test
curl 'https://a.blazemeter.com/api/v4/collections/12345678' \
-X PUT \
-H 'Content-Type: application/json' \
--user 'api_key_id:api_key_secret' \
-d '{"description": "This is an update."}'
Update a Multi-TestUpdate a Multi-Test PUT Body (JSON)
{
"description": "This is an update."
}
Update a Multi-Test Response Attributes
For the all the supported attributes, see the The Multi Test Object.
Response200 OK
{
"api_version": 4,
"error": null,
"result": {
"id": 12345678,
"name": "My Multi-Test",
"description": "This is an update.",
"collectionType": "multiV4",
"userId": 123456,
"items": [],
"oldVersionId": null,
"lastRunTime": null,
"draftId": null,
"filesToSplit": [],
"dataFiles": [],
"creatorClientId": "api",
"testsForExecutions": [
{
"testId": 1234567,
"executions": [
{
"concurrency": 10,
"holdFor": "19m",
"rampUp": "1m",
"steps": 0,
"locations": {
"us-east-1": 10
},
"locationsPercents": {
"us-east-1": 100
},
"executor": "jmeter",
"testId": 1234567,
"scenario": "default-scenario-1234567"
}
],
"overrideExecutions": [
{
"concurrency": 10,
"executor": "jmeter",
"holdFor": "19m",
"locations": {
"us-east-1": 10
},
"locationsPercents": {
"us-east-1": 100
},
"rampUp": "1m",
"steps": 0,
"locationsWeighted": null
}
]
},
{
"testId": 2345678,
"executions": [
{
"concurrency": 20,
"holdFor": "19m",
"rampUp": "1m",
"steps": 0,
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"executor": "jmeter",
"testId": 2345678,
"scenario": "default-scenario-2345678"
}
],
"overrideExecutions": [
{
"concurrency": 20,
"executor": "jmeter",
"holdFor": "19m",
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"rampUp": "1m",
"steps": 0
}
]
}
],
"migratedFromTestCollectionId": null,
"migratedToTestId": null,
"v4MigratedDate": null,
"underMigration": null,
"shouldSendReportEmail": true,
"created": 1552063283,
"updated": 1552084407,
"note": null,
"projectId": 123456,
"lastUpdatedById": null,
"kpiTrackingData": null,
"tests": [
{
"id": 1234567,
"isNewTest": true,
"lastRunTime": 1552060161,
"name": "New Dummy Test V4 2",
"userId": 123456,
"creatorClientId": "gui",
"overrideExecutions": [
{
"concurrency": 20,
"executor": "jmeter",
"holdFor": "19m",
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"rampUp": "1m",
"steps": 0
}
],
"executions": [
{
"concurrency": 20,
"holdFor": "19m",
"rampUp": "1m",
"steps": 0,
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"executor": "jmeter",
"scenario": "default-scenario-1234567"
}
],
"shouldSendReportEmail": false,
"created": 1542289535,
"updated": 1552060217,
"configuration": {
"type": "taurus",
"canControlRampup": false,
"targetThreads": 500,
"executionType": "taurusCloud",
"scriptType": "jmeter",
"threads": 500,
"filename": "Dummy.jmx",
"testMode": "",
"plugins": {
"jmeter": {
"version": "auto"
},
"thresholds": {
"thresholds": [],
"ignoreRampup": false,
"slidingWindow": false
}
}
},
"fileErrors": []
},
{
"id": 2345678,
"isNewTest": true,
"lastRunTime": 1552060161,
"name": "Parallel Controller Script V4",
"userId": 123456,
"creatorClientId": "gui",
"overrideExecutions": [
{
"concurrency": 20,
"executor": "jmeter",
"holdFor": "19m",
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"rampUp": "1m",
"steps": 0
}
],
"executions": [
{
"concurrency": 20,
"holdFor": "19m",
"rampUp": "1m",
"steps": 0,
"locations": {
"us-east-1": 20
},
"locationsPercents": {
"us-east-1": 100
},
"executor": "jmeter",
"scenario": "default-scenario-2345678"
}
],
"shouldSendReportEmail": false,
"created": 1545324446,
"updated": 1552060219,
"configuration": {
"type": "taurus",
"canControlRampup": false,
"targetThreads": 500,
"executionType": "taurusCloud",
"scriptType": "jmeter",
"threads": 500,
"filename": "DummyParallelControllerGenerateParent.jmx",
"testMode": "",
"plugins": {
"jmeter": {
"version": "auto"
},
"thresholds": {
"thresholds": [],
"ignoreRampup": false,
"slidingWindow": false
}
}
},
"fileErrors": []
}
],
"masters": []
}
}