REST API Reference

Back Next

Updating a test suite

Use the following URI to update a test suite:

PUT /datavalidation-service/api/v1/testsuite/{testSuiteId}

Use the IDS-SESSION-ID header in the PUT request.

PUT request: Use the following fields in the PUT request:

Field
Required?
Description

name
Yes
Name of the test suite.

description
No
Description of the test suite.

frsDocLocation
Yes
The location to save the test suite.

testCases
Yes
For each test case that you want to update in the test suite, enter the following details:
testCaseId
. ID of the test case.
name
. Name of the test case.
folder
. Folder where the test case is saved.
project
. Project where the test case is saved.
PUT response: If the test suite was updated successfully, the PUT request returns a
200 Successful operation
response and returns the following response fields:

Field
Type
Description

name
String
Name of the test suite.

description
String
Description of the test suite.

frsDocLocation
String
The location where the test suite is saved.

testCases
Array
For each test case that was updated in the test suite, you see the following details:
testCaseId
. ID of the test case.
name
. Name of the test case.
folder
. Folder where the test case is saved.
project
. Project where the test case is saved.

If the test suite update failed, the PUT request returns a
500 Internal Server Error
response. It also returns the following response fields:

Field
Type
Description

code
String
Code of the error message.

message
String
Error message.

debugMessage
String
Message that can be used for debugging the issue.

details
String
Detailed information about the error message.

Field	Required?	Description
name	Yes	Name of the test suite.
description	No	Description of the test suite.
frsDocLocation	Yes	The location to save the test suite.
testCases	Yes	For each test case that you want to update in the test suite, enter the following details: testCaseId . ID of the test case. name . Name of the test case. folder . Folder where the test case is saved. project . Project where the test case is saved.

Field	Type	Description
name	String	Name of the test suite.
description	String	Description of the test suite.
frsDocLocation	String	The location where the test suite is saved.
testCases	Array	For each test case that was updated in the test suite, you see the following details: testCaseId . ID of the test case. name . Name of the test case. folder . Folder where the test case is saved. project . Project where the test case is saved.

Field	Type	Description
code	String	Code of the error message.
message	String	Error message.
debugMessage	String	Message that can be used for debugging the issue.
details	String	Detailed information about the error message.