Update Test Suite Entity by Type and Full Name
PUT {{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}
The PUT /test-suite/{{testSuiteType}}/{{testSuiteEntryFullName}} operation updates a test suite entity identified by the entity’s type and full name. The allowable values for {{testSuiteType}} are TEST_CASE, TEST_SCENARIO, or ASSERTION. Get the entity’s full name from the response after creating a test suite entity. The request must provide either a branch ID or a snapshot ID in the request URL to specify where the test suite entity should be updated.
Prerequisites
-
Create a branch to get a branch ID.
-
Create a snapshot to get a snapshot ID.
-
Create a test suite entity to get a test suite entity ID and version ID.
Query parameters
| Query parameter | Description |
|---|---|
|
Branch ID or name |
|
Snapshot ID |
Request Model
For property descriptions, refer to Test suite data model.
=== Test scenario request model
| Property | Type | Required |
|---|---|---|
|
String |
Required |
|
String |
Optional |
|
UUID |
Optional |
|
String |
Required |
|
JSON[] |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
JSON |
Optional |
|
JSON |
Optional |
To create an test scenario group rather than an individual test scenario, set the testScenario property to null.
=== Test case request model
| Property | Type | Required |
|---|---|---|
|
String |
Required |
|
String |
Optional |
|
UUID |
Optional |
|
String |
Required |
|
JSON[] |
Optional |
|
Boolean |
Optional |
|
Required |
|
|
Optional |
|
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
JSON |
Optional |
|
JSON |
Optional |
To create an test case group rather than an individual test case, set the testCase property to null.
=== Assertion data model
| Property | Type | Required |
|---|---|---|
|
String |
Required |
|
String |
Optional |
|
UUID |
Optional |
|
String |
Required |
|
JSON[] |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Optional |
|
String |
Required |
|
String |
Required |
To create an assertion group rather than an individual assertion, set the assertion property to null.
Body
raw ( application/json )
{
"id": {{entityId}},
"version": {{versionId}},
"name": "updated-child-test-case",
"description": "updated child test case",
"domainId": {{domainId}},
"serviceId": {{serviceId}},
"identityProviderId": {{identityProviderId}},
"actionId": {{actionId}},
"attributeOverrides": {},
"serviceOverrides": {}
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PUT '{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}' \
--header 'x-user-id: {{userId}}' \
--header 'Content-Type: application/json' \
--data '{
"id": {{entityId}},
"version": {{versionId}},
"name": "updated-child-test-case",
"description": "updated child test case",
"domainId": {{domainId}},
"serviceId": {{serviceId}},
"identityProviderId": {{identityProviderId}},
"actionId": {{actionId}},
"attributeOverrides": {},
"serviceOverrides": {}
}'
var options = new RestClientOptions("{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("x-user-id", "{{userId}}");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@" ""id"": {{entityId}}," + "\n" +
@" ""version"": {{versionId}}," + "\n" +
@" ""name"": ""updated-child-test-case""," + "\n" +
@" ""description"": ""updated child test case""," + "\n" +
@" ""domainId"": {{domainId}}," + "\n" +
@" ""serviceId"": {{serviceId}}," + "\n" +
@" ""identityProviderId"": {{identityProviderId}}," + "\n" +
@" ""actionId"": {{actionId}}," + "\n" +
@" ""attributeOverrides"": {}," + "\n" +
@" ""serviceOverrides"": {}" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}"
method := "PUT"
payload := strings.NewReader(`{
"id": {{entityId}},
"version": {{versionId}},
"name": "updated-child-test-case",
"description": "updated child test case",
"domainId": {{domainId}},
"serviceId": {{serviceId}},
"identityProviderId": {{identityProviderId}},
"actionId": {{actionId}},
"attributeOverrides": {},
"serviceOverrides": {}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("x-user-id", "{{userId}}")
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
PUT /test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}} HTTP/1.1
Host: {{apiPath}}
x-user-id: {{userId}}
Content-Type: application/json
{
"id": {{entityId}},
"version": {{versionId}},
"name": "updated-child-test-case",
"description": "updated child test case",
"domainId": {{domainId}},
"serviceId": {{serviceId}},
"identityProviderId": {{identityProviderId}},
"actionId": {{actionId}},
"attributeOverrides": {},
"serviceOverrides": {}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"id\": {{entityId}},\n \"version\": {{versionId}},\n \"name\": \"updated-child-test-case\",\n \"description\": \"updated child test case\",\n \"domainId\": {{domainId}},\n \"serviceId\": {{serviceId}},\n \"identityProviderId\": {{identityProviderId}},\n \"actionId\": {{actionId}},\n \"attributeOverrides\": {},\n \"serviceOverrides\": {}\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}")
.method("PUT", body)
.addHeader("x-user-id", "{{userId}}")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}",
"method": "PUT",
"timeout": 0,
"headers": {
"x-user-id": "{{userId}}",
"Content-Type": "application/json"
},
"data": "{\n \"id\": {{entityId}},\n \"version\": {{versionId}},\n \"name\": \"updated-child-test-case\",\n \"description\": \"updated child test case\",\n \"domainId\": {{domainId}},\n \"serviceId\": {{serviceId}},\n \"identityProviderId\": {{identityProviderId}},\n \"actionId\": {{actionId}},\n \"attributeOverrides\": {},\n \"serviceOverrides\": {}\n}",
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'PUT',
'url': '{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}',
'headers': {
'x-user-id': '{{userId}}',
'Content-Type': 'application/json'
},
body: '{\n "id": {{entityId}},\n "version": {{versionId}},\n "name": "updated-child-test-case",\n "description": "updated child test case",\n "domainId": {{domainId}},\n "serviceId": {{serviceId}},\n "identityProviderId": {{identityProviderId}},\n "actionId": {{actionId}},\n "attributeOverrides": {},\n "serviceOverrides": {}\n}'
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}"
payload = "{\n \"id\": {{entityId}},\n \"version\": {{versionId}},\n \"name\": \"updated-child-test-case\",\n \"description\": \"updated child test case\",\n \"domainId\": {{domainId}},\n \"serviceId\": {{serviceId}},\n \"identityProviderId\": {{identityProviderId}},\n \"actionId\": {{actionId}},\n \"attributeOverrides\": {},\n \"serviceOverrides\": {}\n}"
headers = {
'x-user-id': '{{userId}}',
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'x-user-id' => '{{userId}}',
'Content-Type' => 'application/json'
));
$request->setBody('{\n "id": {{entityId}},\n "version": {{versionId}},\n "name": "updated-child-test-case",\n "description": "updated child test case",\n "domainId": {{domainId}},\n "serviceId": {{serviceId}},\n "identityProviderId": {{identityProviderId}},\n "actionId": {{actionId}},\n "attributeOverrides": {},\n "serviceOverrides": {}\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["x-user-id"] = "{{userId}}"
request["Content-Type"] = "application/json"
request.body = "{\n \"id\": {{entityId}},\n \"version\": {{versionId}},\n \"name\": \"updated-child-test-case\",\n \"description\": \"updated child test case\",\n \"domainId\": {{domainId}},\n \"serviceId\": {{serviceId}},\n \"identityProviderId\": {{identityProviderId}},\n \"actionId\": {{actionId}},\n \"attributeOverrides\": {},\n \"serviceOverrides\": {}\n}"
response = http.request(request)
puts response.read_body
let parameters = "{\n \"id\": {{entityId}},\n \"version\": {{versionId}},\n \"name\": \"updated-child-test-case\",\n \"description\": \"updated child test case\",\n \"domainId\": {{domainId}},\n \"serviceId\": {{serviceId}},\n \"identityProviderId\": {{identityProviderId}},\n \"actionId\": {{actionId}},\n \"attributeOverrides\": {},\n \"serviceOverrides\": {}\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}")!,timeoutInterval: Double.infinity)
request.addValue("{{userId}}", forHTTPHeaderField: "x-user-id")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpMethod = "PUT"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"objectType": "TestScenarioDefinition",
"id": "653036d3-8b01-4dca-b833-e7a9663ad7b7",
"version": "57043d78-6d8b-4f35-bee1-a004230f415f",
"type": "TEST_SCENARIO",
"name": "example-test-scenario",
"fullName": "example-test-scenario",
"description": "",
"parentId": null,
"numberOfChildren": 0,
"permissions": {
"inherit": true,
"rolePermissions": []
},
"testScenario": {
"request": {
"domainId": null,
"serviceId": "25769e5c-5b33-4daf-9780-3e09b6f32207",
"identityProviderId": null,
"actionId": "b072d76e-0085-4423-99c2-4e16b74e88fa",
"attributes": {}
},
"attributeOverrides": {},
"serviceOverrides": {}
},
"properties": []
}