Akamai APIs API Documentation
Update a test suite with child objects
PUT https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/with-child-objects
Updates a test suite and included test cases and variables.
Body
PARAM
| Key | Datatype | Required | Description |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"configs": {
"propertyManager": {
"propertyId": 1234,
"propertyName": "config_user8",
"propertyVersion": 4
}
},
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"executableTestCaseCount": 3,
"isLocked": true,
"isStateful": true,
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:14+0000",
"testCases": [
{
"clientProfile": {
"client": "CURL",
"ipVersion": "IPV4"
},
"condition": {
"conditionExpression": "Response header \"Content-Type\" has a value that ends with \"{{contentTypeValue}}\"",
"conditionExpressionResolved": "Response header \"Content-Type\" has a value that ends with \"json\""
},
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:14+0000",
"order": 1,
"setVariables": [
{
"variableId": 201,
"variableName": "hostname",
"variableValue": "fn_getResponseHeaderValue(\"headerName\", \".*\")"
}
],
"testCaseId": 301,
"testRequest": {
"requestHeaders": [
{
"headerAction": "ADD",
"headerName": "Accept",
"headerValue": "v1"
}
],
"requestMethod": "POST",
"testRequestUrl": "https://{{hostname}}/"
}
},
{
"clientProfile": {
"client": "CHROME",
"ipVersion": "IPV4"
},
"condition": {
"conditionExpression": "Response code is one of \"{{successCode.statusCodes}}\""
},
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"derivedTestCases": [
{
"clientProfile": {
"client": "CHROME",
"ipVersion": "IPV4"
},
"condition": {
"conditionExpression": "Response code is one of \"200\""
},
"order": 1,
"testRequest": {
"requestMethod": "GET",
"testRequestUrl": "https://abc.com/index"
}
},
{
"clientProfile": {
"client": "CHROME",
"ipVersion": "IPV4"
},
"condition": {
"conditionExpression": "Response code is one of \"200\""
},
"order": 2,
"testRequest": {
"requestMethod": "GET",
"testRequestUrl": "https://def.org/index"
}
}
],
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:13+0000",
"order": 3,
"testCaseId": 303,
"testRequest": {
"requestMethod": "GET",
"testRequestUrl": "https://{{sampleVarGroup.urls}}/index"
}
}
],
"testSuiteDescription": "This test suite performs basic check of www.user8.example.com",
"testSuiteId": 284,
"testSuiteName": "www.user8.example.com test suite",
"variables": [
{
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"isDynamicallyUsed": false,
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:13+0000",
"variableId": 201,
"variableName": "hostname",
"variableValue": "www.user8.example.com"
},
{
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"isDynamicallyUsed": false,
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:13+0000",
"variableId": 202,
"variableName": "contentTypeValue",
"variableValue": "json"
},
{
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:13+0000",
"variableGroupValue": [
{
"columnHeader": "urls",
"columnValues": [
"abc.com",
"def.org"
]
}
],
"variableId": 203,
"variableName": "sampleVarGroup"
},
{
"createdBy": "jperez",
"createdDate": "2023-04-12T10:28:13+0000",
"modifiedBy": "jperez",
"modifiedDate": "2023-04-12T10:28:13+0000",
"variableGroupValue": [
{
"columnHeader": "statusCodes",
"columnValues": [
"200",
"200"
]
}
],
"variableId": 204,
"variableName": "successCode"
}
]
} |
Curl
curl -X PUT 'https://undefined/test-management/v3/functional/test-suites/:testSuiteId/with-child-objects?accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"configs":{"propertyManager":{"propertyId":1234,"propertyVersion":4}},"isLocked":true,"isStateful":true,"testCases":[{"clientProfile":{"client":"CURL","ipVersion":"IPV4"},"condition":{"conditionExpression":"Response header \"Content-Type\" has a value that ends with \"undefined\""},"setVariables":[{"variableName":"hostname","variableValue":"fn_getResponseHeaderValue(\"headerName\", \".*\")"}],"testCaseId":301,"testRequest":{"requestHeaders":[{"headerAction":"ADD","headerName":"Accept","headerValue":"v1"}],"requestMethod":"POST","testRequestUrl":"https://undefined/"}},{"clientProfile":{"client":"CHROME","ipVersion":"IPV4"},"condition":{"conditionExpression":"Response code is one of \"undefined\""},"testRequest":{"requestMethod":"GET","testRequestUrl":"https://undefined/index"}}],"testSuiteDescription":"This test suite performs basic check of www.user8.example.com","testSuiteName":"www.user8.example.com test suite","variables":[{"variableId":201,"variableName":"hostname","variableValue":"www.user8.example.com"},{"variableId":202,"variableName":"contentTypeValue","variableValue":"json"},{"variableGroupValue":[{"columnHeader":"urls","columnValues":["abc.com","def.org"]}],"variableName":"sampleVarGroup"},{"variableGroupValue":[{"columnHeader":"statusCodes","columnValues":["200","200"]}],"variableName":"successCode"}]}'
ENDPOINTS